search

sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.52k stars 2.12k forks source link

appendix handling #2502

Open bjb opened 8 years ago

bjb commented 8 years ago

The conf file keyword and handling for appendix files is different between epub, info and pdf files, and there is no keyword for appendices in html.

It would be awesome if they could all be treated the same way.

eg, epub_post_files takes tuples and you name the rst files. but latex_appendices and texinfo_appendices take a list of names, and it is not clear if these are extensionless names of .rst files or names of .info files or what. And, if the file is named appendix_1 (so it will sort correctly in a directory listing) how do you get the title to be APPENDIX I (as you can with epub)?

rra commented 7 years ago

On a closely related note, I would like to be able to number appendices with letters instead of numbers. I'm currently using two separate .. toctree directives in the master document, and that generates two separate section numbering sequences for HTML, but only one sequence for LaTeX output, and even for HTML both sequences use numbers. I want appendices to be A, B, C, etc. in all output formats.

jessetan commented 6 years ago

If this is ever picked up, there are some useful comments in #3432. I've also started using ..raw:: latex instead of latex_appendices because of the orphan issues mentioned there, as well as undesired page order when combined with bibliographies using sphinxcontrib-bibtex.

@rra see #4133 for ideas about section numbering/lettering