Return-Path: Received: from mailhub-auth-4.mit.edu (MAILHUB-AUTH-4.MIT.EDU [18.7.62.39]) by krbdev.mit.edu (Postfix) with ESMTPS id 6D0683EF4A for ; Wed, 28 Nov 2012 11:37:40 -0500 (EST) Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id qASGbdsl016009 for ; Wed, 28 Nov 2012 11:37:39 -0500 Received: from multics.mit.edu (SYSTEM-LOW-SIPB.MIT.EDU [18.187.2.37]) (authenticated bits=56) (User authenticated as kaduk@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id qASGbb8o026116 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT) for ; Wed, 28 Nov 2012 11:37:39 -0500 (EST) Received: (from kaduk@localhost) by multics.mit.edu (8.12.9.20060308) id qASGbaXF005273; Wed, 28 Nov 2012 11:37:36 -0500 (EST) Date: Wed, 28 Nov 2012 11:37:36 -0500 (EST) From: Benjamin Kaduk To: Zhanna Tsitkova via RT Subject: Re: [krbdev.mit.edu #7447] Fix warnings in doc build In-Reply-To: Message-ID: References: User-Agent: Alpine 1.10 (GSO 962 2008-03-14) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed RT-Send-Cc: X-RT-Original-Encoding: us-ascii Content-Length: 1482 On Wed, 28 Nov 2012, Zhanna Tsitkova via RT wrote: > [kaduk@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 >> 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. Hmm, this may be a Sphinx bug, I'll try to look and see. Why is it undesirable to have the license information in the sidebar? -Ben