krb5 commit [krb5-1.11]: Remove last "document not in toctree" warnings

Tom Yu tlyu at MIT.EDU
Thu Nov 29 16:04:15 EST 2012


https://github.com/krb5/krb5/commit/176bc9ae9a65f3016cb433128be0ef794ef491ea
commit 176bc9ae9a65f3016cb433128be0ef794ef491ea
Author: Ben Kaduk <kaduk at mit.edu>
Date:   Tue Nov 20 18:06:22 2012 -0500

    Remove last "document not in toctree" warnings
    
    There were two of them, for notice.rst and mitK5license.rst.
    The former is included in the latter, which is linked to from
    the mitK5features document but not listed in a table of contents
    otherwise.  Includes are processed unconditionally, so we can
    add notice.rst to the exclude_patterns array (formerly unused_docs)
    and its content will still be included.
    
    If we attempt to do the same for mitK5license.rst, it is not processed
    at all, and the attempt to link to it will fail.  Instead, put a dummy
    table of contents in the mitK5features document (which links to the
    license document), with the "hidden" attribute.  This satisfies the
    Sphinx need to know where all the input documents are without changing
    the displayed table of contents.
    
    (cherry picked from commit b358b505be4502a71495ce58b8444027121726ee)
    
    ticket: 7447
    version_fixed: 1.11
    status: resolved

 doc/conf.py           |    1 +
 doc/mitK5features.rst |    5 +++++
 2 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index 259a595..1fb48ad 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -256,6 +256,7 @@ if 'notice' in tags:
                           'mitK5*.rst', 'resources.rst' ]
     rst_epilog += '.. |copy| replace:: \(C\)'
 else:
+    exclude_patterns += [ 'notice.rst' ]
     rst_epilog += '.. |bindir| replace:: %s\n' % bindir
     rst_epilog += '.. |sbindir| replace:: %s\n' % sbindir
     rst_epilog += '.. |libdir| replace:: %s\n' % libdir
diff --git a/doc/mitK5features.rst b/doc/mitK5features.rst
index d168f43..cf1e62b 100644
--- a/doc/mitK5features.rst
+++ b/doc/mitK5features.rst
@@ -1,5 +1,10 @@
 .. highlight:: rst
 
+.. toctree::
+    :hidden:
+
+    mitK5license.rst
+
 .. _mitK5features:
 
 MIT Kerberos features


More information about the cvs-krb5 mailing list