Sphinx: appendix handling

Created on 28 Apr 2016  路  2Comments  路  Source: sphinx-doc/sphinx

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)?

enhancement epub latex texinfo toctree

Most helpful comment

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.

All 2 comments

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.

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ubershmekel picture ubershmekel  路  3Comments

samweisgamdschie picture samweisgamdschie  路  3Comments

jessetan picture jessetan  路  3Comments

shimizukawa picture shimizukawa  路  3Comments

shimizukawa picture shimizukawa  路  3Comments