[krbdev.mit.edu #7447] SVN Commit

Tom Yu via RT rt-comment at krbdev.mit.edu
Thu Nov 29 16:04:17 EST 2012


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)

https://github.com/krb5/krb5/commit/176bc9ae9a65f3016cb433128be0ef794ef491ea
Author: Ben Kaduk <kaduk at mit.edu>
Committer: Tom Yu <tlyu at mit.edu>
Commit: 176bc9ae9a65f3016cb433128be0ef794ef491ea
Branch: krb5-1.11
 doc/conf.py           |    1 +
 doc/mitK5features.rst |    5 +++++
 2 files changed, 6 insertions(+), 0 deletions(-)



More information about the krb5-bugs mailing list