diff options
| author | Tom Yu <tlyu@mit.edu> | 2012-10-19 16:03:57 -0400 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-11-14 14:09:03 -0500 |
| commit | 3f7aebe3f77fc99200f863f66c064614509d7882 (patch) | |
| tree | f7e61b760a4f438b46601855148e9b721ebdad73 /doc/conf.py | |
| parent | 07c77b51d33c23d3ea28d588adc43b6c5ec5c20f (diff) | |
| download | krb5-3f7aebe3f77fc99200f863f66c064614509d7882.tar.gz krb5-3f7aebe3f77fc99200f863f66c064614509d7882.tar.xz krb5-3f7aebe3f77fc99200f863f66c064614509d7882.zip | |
Use main conf.py for NOTICE
Generate the NOTICE file using the main conf.py, by using a special
tag when invoking sphinx-build.
While here, add notice.txt to the list of files removed by make clean.
ticket: 7433
tags: pullup
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/doc/conf.py b/doc/conf.py index fafae15e55..066768496c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -38,7 +38,10 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' # The master toctree document. -master_doc = 'index' +if 'notice' in tags: + master_doc = 'notice' +else: + master_doc = 'index' # General information about the project. project = u'MIT Kerberos' @@ -238,19 +241,27 @@ else: ckeytab = ':ref:`DEFCKTNAME <paths>`' rst_epilog = '\n' -rst_epilog += '.. |bindir| replace:: %s\n' % bindir -rst_epilog += '.. |sbindir| replace:: %s\n' % sbindir -rst_epilog += '.. |libdir| replace:: %s\n' % libdir -rst_epilog += '.. |kdcdir| replace:: %s\\ ``/krb5kdc``\n' % localstatedir -rst_epilog += '.. |sysconfdir| replace:: %s\n' % sysconfdir -rst_epilog += '.. |ccache| replace:: %s\n' % ccache -rst_epilog += '.. |keytab| replace:: %s\n' % keytab -rst_epilog += '.. |ckeytab| replace:: %s\n' % ckeytab -rst_epilog += ''' + +if 'notice' in tags: + exclude_patterns = [ 'admins', 'appldev', 'basic', 'build', + 'plugindev', 'relay', 'users' ] + exclude_patterns += [ 'index.rst', 'mitK5*.rst', 'resources.rst' ] + rst_epilog += '.. |copy| replace:: \(C\)' +else: + rst_epilog += '.. |bindir| replace:: %s\n' % bindir + rst_epilog += '.. |sbindir| replace:: %s\n' % sbindir + rst_epilog += '.. |libdir| replace:: %s\n' % libdir + rst_epilog += '.. |kdcdir| replace:: %s\\ ``/krb5kdc``\n' % localstatedir + rst_epilog += '.. |sysconfdir| replace:: %s\n' % sysconfdir + rst_epilog += '.. |ccache| replace:: %s\n' % ccache + rst_epilog += '.. |keytab| replace:: %s\n' % keytab + rst_epilog += '.. |ckeytab| replace:: %s\n' % ckeytab + rst_epilog += ''' .. |krb5conf| replace:: ``/etc/krb5.conf`` .. |defkeysalts| replace:: ``aes256-cts-hmac-sha1-96:normal aes128-cts-hmac-sha1-96:normal des3-cbc-sha1:normal arcfour-hmac-md5:normal`` .. |defetypes| replace:: ``aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1 arcfour-hmac-md5 des-cbc-crc des-cbc-md5 des-cbc-md4`` .. |defmkey| replace:: ``aes256-cts-hmac-sha1-96`` +.. |copy| unicode:: U+000A9 ''' # -- Options for manual page output -------------------------------------------- |