diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-11-20 18:06:22 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-11-27 17:55:03 -0500 |
| commit | b358b505be4502a71495ce58b8444027121726ee (patch) | |
| tree | 06eb6717a4fef184b13bf71743735020d9180c48 | |
| parent | 94947241bd347e9b4dd729c5d550150b7e8cd64c (diff) | |
| download | krb5-b358b505be4502a71495ce58b8444027121726ee.tar.gz krb5-b358b505be4502a71495ce58b8444027121726ee.tar.xz krb5-b358b505be4502a71495ce58b8444027121726ee.zip | |
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
| -rw-r--r-- | doc/conf.py | 1 | ||||
| -rw-r--r-- | doc/mitK5features.rst | 5 |
2 files changed, 6 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py index 259a5957c..1fb48add6 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 d168f43f9..cf1e62bec 100644 --- a/doc/mitK5features.rst +++ b/doc/mitK5features.rst @@ -1,5 +1,10 @@ .. highlight:: rst +.. toctree:: + :hidden: + + mitK5license.rst + .. _mitK5features: MIT Kerberos features |