aboutsummaryrefslogtreecommitdiffstats
path: root/.gitignore
diff options
context:
space:
mode:
authoranarcat <anarcat@users.noreply.github.com>2017-03-20 18:03:12 -0400
committerAlex Gaynor <alex.gaynor@gmail.com>2017-03-20 18:03:12 -0400
commitfd2b27aa063c31258482c9b432c80c98b5a93f07 (patch)
treecf46a728dc9764b6e1c0e45bcdd294edb90a619f /.gitignore
parent9bab0edd9cb94825157ce9d491e3474ebb7d6afd (diff)
downloadcryptography-fd2b27aa063c31258482c9b432c80c98b5a93f07.tar.gz
cryptography-fd2b27aa063c31258482c9b432c80c98b5a93f07.tar.bz2
cryptography-fd2b27aa063c31258482c9b432c80c98b5a93f07.zip
add captions to the split toctrees (#3466)
* add captions to the split toctrees 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 * remove spurious backtics in caption they do not work in that field, apparently.
Diffstat (limited to '.gitignore')
0 files changed, 0 insertions, 0 deletions