]> git.ipfire.org Git - thirdparty/krb5.git/commit
Do not generate unused parts of toctree
authorBen Kaduk <kaduk@mit.edu>
Tue, 27 Nov 2012 18:31:34 +0000 (13:31 -0500)
committerBen Kaduk <kaduk@mit.edu>
Mon, 10 Dec 2012 18:01:25 +0000 (13:01 -0500)
commit81fc0331cdf8a41b346daaee32977d76ab645139
treeccacfac60c879d8b7d8c4f2c7afa26bc11cba2c7
parent8bff1e50c28b6f11b771add7bd7d4a57419a567b
Do not generate unused parts of toctree

Our css only displays up to depth 3 of the toctree, partially
because the API reference content explodes at depth 4 and that would
not be pretty to see in the sidebar.  However, we would previously
always generate HTML for the full toctree and hide parts with CSS.
For the apiref, this proved to be about 65k per html file, and we
have one html file per function/type/macro.

Limit the depth of the toctree that gets generated to save on space
in the release tarball.

Unfortunately, there seems to be a Sphinx bug wherein the toctree
will only be generated to depth 1 for a document at a depth greater
than the maxdepth of the toctree, so the sidebar table of contents
on individual apiref pages will just be the toplevel toctree.
This issue is being tracked at
https://bitbucket.org/birkenfeld/sphinx/issue/1046/

ticket: 7466 (new)
tags: pullup
target_version: 1.11
doc/_templates/layout.html