krb5 commit: Do not generate unused parts of toctree

Benjamin Kaduk kaduk at MIT.EDU
Mon Dec 10 13:15:45 EST 2012


https://github.com/krb5/krb5/commit/81fc0331cdf8a41b346daaee32977d76ab645139
commit 81fc0331cdf8a41b346daaee32977d76ab645139
Author: Ben Kaduk <kaduk at mit.edu>
Date:   Tue Nov 27 13:31:34 2012 -0500

    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 |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
index 585e6c5..1822304 100644
--- a/doc/_templates/layout.html
+++ b/doc/_templates/layout.html
@@ -66,7 +66,7 @@
                     {{ toc }}
                     <br/>
                     <h2>{{ _('Table of contents') }}</h2>
-                    {{ toctree(collapse=true, maxdepth=-1, titles_only=true) }}
+                    {{ toctree(collapse=true, maxdepth=3, titles_only=true) }}
                     <br/>
                     <h4><a href="{{ pathto('index') }}">Full Table of Contents
                     </a></h4>


More information about the cvs-krb5 mailing list