add captions to the split toctrees #3466
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this will render the table of contents with separators in the RTD theme. right now, the table of contents is quite confusing on the [RTD site][] - that is because there are 3 distinct `toctree` directives, but no `:caption:` field. instead, there are headers in the `index.rst` but those are not parsed by RTD. [RTD site]: https://cryptography.io/en/latest/ by moving those headers in the `:caption:` field, we keep the heading, but it will also be shown in the left table of contents on the RTD site. for an example of that pattern, see the [scrapy documentation][]. they go even further by hiding the `toctree` elements completely and adding explanations on every section, but this is out of scope here for now. [scrapy documentation]: https://doc.scrapy.org/en/latest/index.html
|
@anarcat, thanks for your PR! By analyzing the history of the files in this pull request, we identified @alex, @skeuomorf and @reaperhulk to be potential reviewers. |
|
Jenkins, ok to test |
alex
reviewed
Mar 20, 2017
docs/index.rst
Outdated
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: The ``cryptography`` open source project |
There was a problem hiding this comment.
Backticks for monospace don't work in caption, can you remove tehm?
alex
reviewed
Mar 20, 2017
they do not work in that field, apparently.
|
@alex alright, done! i must admit i didn't test this explicitly... |
alex
approved these changes
Mar 20, 2017
|
thanks! |
|
Thank you! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this will render the table of contents with separators in the RTD
theme. right now, the table of contents is quite confusing on
the RTD site - that is because there are 3 distinct
toctreedirectives, but no
:caption:field. instead, there are headers inthe
index.rstbut those are not parsed by RTD.by moving those headers in the
:caption:field, we keep the heading,but it will also be shown in the left table of contents on the RTD
site.
for an example of that pattern, see the scrapy documentation. they
go even further by hiding the
toctreeelements completely and addingexplanations on every section, but this is out of scope here for now.