[27263] in CVS-changelog-for-Kerberos-V5
krb5 commit [krb5-1.11]: Use main conf.py for NOTICE
daemon@ATHENA.MIT.EDU (Tom Yu)
Fri Nov 16 14:58:35 2012
Date: Fri, 16 Nov 2012 14:58:20 -0500
From: Tom Yu <tlyu@mit.edu>
Message-Id: <201211161958.qAGJwKkp022279@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/f8ba9944931e4a38ca137256ee251387c3c6a1b0
commit f8ba9944931e4a38ca137256ee251387c3c6a1b0
Author: Tom Yu <tlyu@mit.edu>
Date: Fri Oct 19 16:03:57 2012 -0400
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.
(cherry picked from commit 3f7aebe3f77fc99200f863f66c064614509d7882)
ticket: 7433
doc/conf.py | 31 ++++++++++++------
doc/notice.rst | 2 -
doc/txt_conf.py | 88 ---------------------------------------------------
src/doc/Makefile.in | 19 ++---------
4 files changed, 25 insertions(+), 115 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index fafae15..0667684 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 --------------------------------------------
diff --git a/doc/notice.rst b/doc/notice.rst
index 82f58bd..e8d0d00 100644
--- a/doc/notice.rst
+++ b/doc/notice.rst
@@ -1,5 +1,3 @@
-.. include:: <isonum.txt>
-
Copyright |copy| 1985-2012 by the Massachusetts Institute of Technology.
All rights reserved.
diff --git a/doc/txt_conf.py b/doc/txt_conf.py
deleted file mode 100644
index f9f00e9..0000000
--- a/doc/txt_conf.py
+++ /dev/null
@@ -1,88 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# MIT Kerberos documentation build configuration file, created by
-# sphinx-quickstart on Wed Oct 13 09:14:03 2010.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
-
-# -- General configuration -----------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.doxylink']
-extensions = ['sphinx.ext.autodoc']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'notice'
-
-# General information about the project.
-project = u'MIT Kerberos'
-copyright = u'2012, MIT'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.0.1'
-# The full version, including alpha/beta/rc tags.
-release = '0.0.1'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-today = ' '
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = []
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
diff --git a/src/doc/Makefile.in b/src/doc/Makefile.in
index 2413068..913a50a 100644
--- a/src/doc/Makefile.in
+++ b/src/doc/Makefile.in
@@ -26,8 +26,7 @@ RST_SOURCES= _static \
mitK5license.rst \
notice.rst \
relay \
- resources.rst \
- txt_conf.py
+ resources.rst
# Create HTML documentation in $(docsrc)/html suitable for a
# release tarball or the web site (that is, without substitutions for
@@ -48,8 +47,8 @@ substhtml: composite paths.py
$(SPHINX_BUILD) -t pathsubs -q rst_composite html_subst
# Create an ASCII (okay, UTF-8) version of the NOTICE file
-notice.txt: rst_notice
- $(SPHINX_BUILD) -b text -q rst_notice .
+notice.txt: $(docsrc)/conf.py $(docsrc)/notice.rst
+ $(SPHINX_BUILD) -b text -t notice -q $(docsrc) .
NOTICE: notice.txt
cp notice.txt $(top_srcdir)/../NOTICE
@@ -72,16 +71,6 @@ composite: Doxyfile $(docsrc)/version.py
cp rst_apiref/macros/*.rst rst_composite/appldev/refs/macros
cp $(docsrc)/version.py rst_composite
-# Must use a separate source dir for sphinx text builds, since the text
-# engine cannot handle the row spanning cells in fancy tables that we use
-rst_notice: $(docsrc)/notice.rst $(docsrc)/txt_conf.py $(docsrc)/version.py
- mkdir -p rst_notice
- # reST needs backslashes before parens in this macro definition.
- sed -e 's/include:: <isonum.txt>/|copy| replace:: \\(C\\)/' \
- < $(docsrc)/notice.rst > rst_notice/notice.rst
- cp $(docsrc)/txt_conf.py rst_notice/conf.py
- cp $(docsrc)/version.py rst_notice
-
Doxyfile: $(srcdir)/Doxyfile.in
sed -e 's|@SRC@|$(top_srcdir)|g' \
-e 's|@DOC@|$(top_srcdir)/../doc|g' $(srcdir)/Doxyfile.in > $@
@@ -106,4 +95,4 @@ $(docsrc)/version.py: $(top_srcdir)/patchlevel.h $(srcdir)/version.py.in
clean::
rm -rf doxy rst_apiref rst_composite rst_notice html_subst \
- Doxyfile paths.py $(docsrc)/version.py
+ Doxyfile paths.py $(docsrc)/version.py notice.txt
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
