[krbdev.mit.edu #7447] Fix warnings in doc build

Zhanna Tsitkova via RT rt-comment at krbdev.mit.edu
Wed Nov 28 09:55:23 EST 2012


[kaduk at MIT.EDU - Tue Nov 27 18:02:34 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.
> 
> https://github.com/krb5/krb5/commit/b358b505be4502a71495ce58b8444027121726ee
> Author: Ben Kaduk <kaduk at mit.edu>
> Commit: b358b505be4502a71495ce58b8444027121726ee
> Branch: master
>  doc/conf.py           |    1 +
>  doc/mitK5features.rst |    5 +++++
>  2 files changed, 6 insertions(+), 0 deletions(-)

Now MIT Kerberos License information appears in the sidebar which is undesirable behavior. 



More information about the krb5-bugs mailing list