[27310] in CVS-changelog-for-Kerberos-V5
krb5 commit: Remove last "document not in toctree" warnings
daemon@ATHENA.MIT.EDU (Benjamin Kaduk)
Tue Nov 27 18:03:03 2012
Date: Tue, 27 Nov 2012 18:02:33 -0500
From: Benjamin Kaduk <kaduk@mit.edu>
Message-Id: <201211272302.qARN2XVF023321@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/b358b505be4502a71495ce58b8444027121726ee
commit b358b505be4502a71495ce58b8444027121726ee
Author: Ben Kaduk <kaduk@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.
ticket: 7447
tags: pullup
target_version: 1.11
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
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
