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

diff --git a/doc/conf.py b/doc/conf.py
index 259a5957c35d100a63cc8041036b96eb29f6d371..1fb48add6c26f01ad4a27fa95e40f1b45ae12bb6 100644 (file)
--- 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 d168f43f9d323a5cc2f632354f653fdd56cec11f..cf1e62bec58f1468c507be734bab76559cc2f953 100644 (file)
--- a/doc/mitK5features.rst
+++ b/doc/mitK5features.rst
@@ -1,5 +1,10 @@
 .. highlight:: rst
 
+.. toctree::
+    :hidden:
+
+    mitK5license.rst
+
 .. _mitK5features:
 
 MIT Kerberos features