Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #5453 and move LaTeX \pagestyle to template #5455

Merged
merged 3 commits into from
Sep 20, 2018

Conversation

jfbu
Copy link
Contributor

@jfbu jfbu commented Sep 18, 2018

Bugfix: #5453

No change for 'manual' class (or Japanese documents), but the \sphinxtableofcontents for 'manual' has been modified: the \pagestyle commands therein have been moved to LaTeX template.

Overall this changes nothing to 'manual' documents except for those users who have customized \sphinxtableofcontents in their own way and perhaps don't want the \pagestyle now in LaTeX templates: I expect very few if any project have done that, and in that case the user only needs to use custom LaTeX template to suppress the \pagestyle inserted from it.

@jfbu jfbu added this to the 1.8.1 milestone Sep 18, 2018
@@ -517,17 +533,24 @@
% define chaptermark with \@chappos when \@chappos is available for Japanese
\ltx@ifundefined{@chappos}{}
{\def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}}
}
}
% Update the plain style so we get the page number & footer line,
% but not a chapter or section title. This is to keep the first
% page of a chapter and the blank page between chapters `clean.'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand the "blank page between chapters" bit from this legacy comment. In report class (used by 'manual'), the \chapter command does indeed issue \thispagestyle{plain} after having done \cleardoublepage, but there is no modification of the header/footer style for the last page of previous chapter, if the latter has no contents. Only the first page of new chapter is re-styled via the \thispagestyle{plain} arising from \chapter.

Thus I should probably remove this old comment which I believe to be misleading.

@codecov
Copy link

codecov bot commented Sep 18, 2018

Codecov Report

Merging #5455 into 1.8 will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              1.8    #5455      +/-   ##
==========================================
+ Coverage   82.05%   82.05%   +<.01%     
==========================================
  Files         305      299       -6     
  Lines       40341    40002     -339     
  Branches     6235     6181      -54     
==========================================
- Hits        33100    32822     -278     
+ Misses       5857     5804      -53     
+ Partials     1384     1376       -8
Impacted Files Coverage Δ
sphinx/make_mode.py
sphinx/search/__init__.py
sphinx/quickstart.py
sphinx/errors.py
sphinx/__init__.py
sphinx/apidoc.py
sphinx/builders/html.py 82.93% <0%> (+0.09%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6097790...f1b7969. Read the comment docs.

3 similar comments
@codecov
Copy link

codecov bot commented Sep 18, 2018

Codecov Report

Merging #5455 into 1.8 will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              1.8    #5455      +/-   ##
==========================================
+ Coverage   82.05%   82.05%   +<.01%     
==========================================
  Files         305      299       -6     
  Lines       40341    40002     -339     
  Branches     6235     6181      -54     
==========================================
- Hits        33100    32822     -278     
+ Misses       5857     5804      -53     
+ Partials     1384     1376       -8
Impacted Files Coverage Δ
sphinx/make_mode.py
sphinx/search/__init__.py
sphinx/quickstart.py
sphinx/errors.py
sphinx/__init__.py
sphinx/apidoc.py
sphinx/builders/html.py 82.93% <0%> (+0.09%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6097790...f1b7969. Read the comment docs.

@codecov
Copy link

codecov bot commented Sep 18, 2018

Codecov Report

Merging #5455 into 1.8 will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              1.8    #5455      +/-   ##
==========================================
+ Coverage   82.05%   82.05%   +<.01%     
==========================================
  Files         305      299       -6     
  Lines       40341    40002     -339     
  Branches     6235     6181      -54     
==========================================
- Hits        33100    32822     -278     
+ Misses       5857     5804      -53     
+ Partials     1384     1376       -8
Impacted Files Coverage Δ
sphinx/make_mode.py
sphinx/search/__init__.py
sphinx/quickstart.py
sphinx/errors.py
sphinx/__init__.py
sphinx/apidoc.py
sphinx/builders/html.py 82.93% <0%> (+0.09%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6097790...f1b7969. Read the comment docs.

@codecov
Copy link

codecov bot commented Sep 18, 2018

Codecov Report

Merging #5455 into 1.8 will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              1.8    #5455      +/-   ##
==========================================
+ Coverage   82.05%   82.05%   +<.01%     
==========================================
  Files         305      299       -6     
  Lines       40341    40002     -339     
  Branches     6235     6181      -54     
==========================================
- Hits        33100    32822     -278     
+ Misses       5857     5804      -53     
+ Partials     1384     1376       -8
Impacted Files Coverage Δ
sphinx/make_mode.py
sphinx/search/__init__.py
sphinx/quickstart.py
sphinx/errors.py
sphinx/__init__.py
sphinx/apidoc.py
sphinx/builders/html.py 82.93% <0%> (+0.09%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6097790...f1b7969. Read the comment docs.

@codecov
Copy link

codecov bot commented Sep 18, 2018

Codecov Report

Merging #5455 into 1.8 will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              1.8    #5455      +/-   ##
==========================================
- Coverage   82.05%   82.05%   -0.01%     
==========================================
  Files         306      306              
  Lines       40350    40350              
  Branches     6236     6236              
==========================================
- Hits        33109    33108       -1     
  Misses       5858     5858              
- Partials     1383     1384       +1
Impacted Files Coverage Δ
sphinx/builders/html.py 82.83% <0%> (-0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b2836a...94bb3e3. Read the comment docs.

@jfbu
Copy link
Contributor Author

jfbu commented Sep 18, 2018

Codecov seems to have gone beserk (perhaps due to me force pushing twice shortly after having already made PR).

If there is one more Codecov report soon I will close and reopen to try to stop the flood...

Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@jfbu
Copy link
Contributor Author

jfbu commented Sep 20, 2018

Thanks for review @tk0miya. I will push a commit to remove the legacy comment about "keeping clean the blank page between chapters" which I find misleading and to add a CHANGES entry, then I will merge.

@jfbu jfbu merged commit e4c6963 into sphinx-doc:1.8 Sep 20, 2018
@jfbu jfbu deleted the 5453_PDF_howto_pagenumbers branch September 20, 2018 20:34
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants