Mercurial > p > roundup > code

annotate doc/conf.py @ 8446:14c7c07b32d8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
feature: add thread local trace_id and trace_reason to logging. Added trace_id to default logging so that all logs for a given request share the same trace_id. This allows correlation of logs across a request. admin_guide.txt, upgrading.txt: add docs update sample configs to include trace_id. rewrite logging docs in admin_guide. Hopefully they are clearer now. clean up some stuff in the logging config file docs. admin.py: add decorators to run_command to enable trace_id. change calls to db.commit() to use run_command to get trace_id. configuration.py: clean up imports. update docstrings, comments and inline docs. add trace_id to default log format. add function for testing decorated with trace_id. add support for dumping stack trace in logging. add check for pytest in sys.modules to enable log propagation when pytest is running. Otherwise tests fail as the caplog logger doesn't see the roundup logs. logcontext.py: new file to handle thread local contextvar mangement. mailgw.py: add decorators for trace_id etc. scripts/roundup_xlmrpc_server.py: add decorators for trace_id etc. fix encoding bug turning bytes into a string. fix command line issue where we can't set encoding. (not sure if changing encoding via command line even works) cgi/client.py decorate two entry points for trace_id etc. cgi/wsgi_handler.py: decorate entry point for trace_id etc. test/test_config.py: add test for trace_id in new log format. test various cases for sinfo and errors in formating msg.
author John Rouillard <rouilj@ieee.org>
date Tue, 16 Sep 2025 22:53:00 -0400
parents b0539a19ca65
children 63665d93940b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
2
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
3 # -- Roundup Notice --
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
4 # This conf.py is used to generate local documentation. There is also
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
5 # website/www/conf.py in Roundup repository which uses the same .rst
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
6 # sources, but different setup to generate site contents.
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
7 # ---
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
8
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
9 # Roundup documentation build configuration file, created by
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
10 # sphinx-quickstart on Tue Jan 20 17:33:20 2009.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
11 #
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
12 # This file is execfile()d with the current directory set to its
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
13 # containing dir.
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
14 #
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
15 # Note that not all possible configuration values are present in this
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
16 # autogenerated file.
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
17 #
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
18 # All configuration values have a default; values that are commented out
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
19 # serve to show the default.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
20
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
21 import sys
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
22 import os
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
23
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
24
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
25 # Read Roundup version by importing it from parent directory,
7468
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 6990
diff changeset
26 # this ensures that 'unknown version' is inserted even if
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
27 # `roundup` is importable from other location in sys.path
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
28 SYSSAVE = sys.path
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
29 DOCROOT = os.path.abspath(os.path.dirname(__file__))
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
30 sys.path = [os.path.dirname(DOCROOT)]
4832
76460d14be91 Read version and release for generated documentation from roundup/__init__.py
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4357
diff changeset
31 try:
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
32 from roundup import __version__ as VERSION
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
33 SHORTVER = '.'.join(VERSION.split('.', 2)[:2])
4832
76460d14be91 Read version and release for generated documentation from roundup/__init__.py
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4357
diff changeset
34 except ImportError:
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
35 VERSION = SHORTVER = '(unknown version)'
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
36 finally:
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
37 sys.path = SYSSAVE
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
38
4832
76460d14be91 Read version and release for generated documentation from roundup/__init__.py
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4357
diff changeset
39
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
40 # If extensions (or modules to document with autodoc) are in another directory,
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
41 # add these directories to sys.path here. If the directory is relative to the
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
42 # documentation root, use os.path.abspath to make it absolute, like shown here.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
43 #sys.path.insert(0, os.path.abspath('.'))
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
44
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
45 # -- General configuration ------------------------------------------------
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
46
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
47 # If your documentation needs a minimal Sphinx version, state it here.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
48 #needs_sphinx = '1.0'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
49
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
50 # Add any Sphinx extension module names here, as strings. They can be
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
51 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
52 # ones.
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
53 #extensions = ['toctree']
8369
b0539a19ca65 build: add autodoc to sphinx extension list
John Rouillard <rouilj@ieee.org>
parents: 8254
diff changeset
54 extensions = ['sphinx_tabs.tabs', 'sphinx.ext.autodoc']
7740
67438e439da8 docs: issue2551317 add support for jinja2 customization examples
John Rouillard <rouilj@ieee.org>
parents: 7502
diff changeset
55
67438e439da8 docs: issue2551317 add support for jinja2 customization examples
John Rouillard <rouilj@ieee.org>
parents: 7502
diff changeset
56 sphinx_tabs_valid_builders = ['linkcheck']
67438e439da8 docs: issue2551317 add support for jinja2 customization examples
John Rouillard <rouilj@ieee.org>
parents: 7502
diff changeset
57 sphinx_tabs_disable_tab_closing = True
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
58
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
59 # Add any paths that contain templates here, relative to this directory.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
60 templates_path = ['_templates']
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
61
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
62 # The suffix(es) of source filenames.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
63 # You can specify multiple suffix as a list of string:
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
64 # source_suffix = ['.rst', '.md']
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
65 source_suffix = '.txt'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
66
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
67 # The encoding of source files.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
68 #source_encoding = 'utf-8'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
69
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
70 # The master toctree document.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
71 master_doc = 'index'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
72
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
73 # General information about the project.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
74 project = u'Roundup'
8254
c80de1b0dd83 chore: it's 2025, update copyrights
John Rouillard <rouilj@ieee.org>
parents: 8113
diff changeset
75 copyright = u'2009-2025, Richard Jones, Roundup-Team'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
76
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
77 # The version info for the project you're documenting, acts as replacement for
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
78 # |version| and |release|, also used in various other places throughout the
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
79 # built documents.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
80 #
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
81 # The short X.Y version.
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
82 version = SHORTVER
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
83 # The full version, including alpha/beta/rc tags.
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
84 release = VERSION
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
85
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
86 # The language for content autogenerated by Sphinx. Refer to documentation
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
87 # for a list of supported languages.
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
88 #
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
89 # This is also used if you do content translation via gettext catalogs.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
90 # Usually you set "language" from the command line for these cases.
7492
452a8bd1d826 add file with sphinx requirements for building doc.
John Rouillard <rouilj@ieee.org>
parents: 7468
diff changeset
91 language = 'en'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
92
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
93 # There are two options for replacing |today|: either, you set today to some
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
94 # non-false value, then it is used:
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
95 #today = ''
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
96 # Else, today_fmt is used as the format for a strftime call.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
97 #today_fmt = '%B %d, %Y'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
98
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
99 # List of patterns, relative to source directory, that match files and
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
100 # directories to ignore when looking for source files.
5610
0df5f9eeefd4 Changed references to http://issues.roundup-tracker.org to https now
John Rouillard <rouilj@ieee.org>
parents: 5078
diff changeset
101 # see https://issues.roundup-tracker.org/issue2550907:
7919
e3b34d02c61a doc: add html versions of man pages
John Rouillard <rouilj@ieee.org>
parents: 7740
diff changeset
102 exclude_patterns = ['_build', 'tracker_config.txt',
6990
3ce81e49e8d4 re-enable security.html
John Rouillard <rouilj@ieee.org>
parents: 6388
diff changeset
103 'announcement.txt', 'whatsnew-0.7.txt',
8070
34d5c1303a2e docs: do not create CVE.html when processing doc for release
John Rouillard <rouilj@ieee.org>
parents: 7919
diff changeset
104 'whatsnew-0.8.txt', 'CVE.txt']
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
105
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
106 # The reST default role (used for this markup: `text`) to use for all
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
107 # documents.
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
108 #default_role = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
109
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
110 # If true, '()' will be appended to :func: etc. cross-reference text.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
111 #add_function_parentheses = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
112
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
113 # If true, the current module name will be prepended to all description
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
114 # unit titles (such as .. function::).
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
115 #add_module_names = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
116
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
117 # If true, sectionauthor and moduleauthor directives will be shown in the
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
118 # output. They are ignored by default.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
119 #show_authors = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
120
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
121 # The name of the Pygments (syntax highlighting) style to use.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
122 pygments_style = 'sphinx'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
123
7492
452a8bd1d826 add file with sphinx requirements for building doc.
John Rouillard <rouilj@ieee.org>
parents: 7468
diff changeset
124 # disable permalinks
7502
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
125 from sphinx import version_info
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
126 if version_info < (3,5,0):
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
127 html_add_permalinks = ''
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
128 else:
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
129 html_permalinks = False # when sphinx > 3.5 is used.
7492
452a8bd1d826 add file with sphinx requirements for building doc.
John Rouillard <rouilj@ieee.org>
parents: 7468
diff changeset
130
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
131 # A list of ignored prefixes for module index sorting.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
132 #modindex_common_prefix = []
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
133
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
134 # If true, keep warnings as "system message" paragraphs in the built documents.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
135 #keep_warnings = False
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
136
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
137 # -- Options for HTML output ----------------------------------------------
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
138
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
139 #-- pre Sphinx 1.3
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
140 # The style sheet to use for HTML and HTML Help pages. A file of that name
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
141 # must exist either in Sphinx' static/ path, or in one of the custom paths
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
142 # given in html_static_path.
5030
515ab1749b14 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5029
diff changeset
143 html_style = 'style.css'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
144
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
145 #-- Sphinx 1.3
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
146 # The theme to use for HTML and HTML Help pages. See the documentation for
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
147 # a list of builtin themes.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
148 #html_theme = 'alabaster'
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
149
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
150 # Theme options are theme-specific and customize the look and feel of a theme
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
151 # further. For a list of options available for each theme, see the
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
152 # documentation.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
153 #html_theme_options = {}
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
154
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
155 # Add any paths that contain custom themes here, relative to this directory.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
156 #html_theme_path = []
4897
b26176334c88 Fix broken links to static html doc files (issue2550840)
John Kristensen <john@jerrykan.com>
parents: 4837
diff changeset
157
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
158 # The name for this set of Sphinx documents. If None, it defaults to
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
159 # "<project> v<release> documentation".
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
160 #html_title = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
161
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
162 # A shorter title for the navigation bar. Default is the same as html_title.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
163 #html_short_title = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
164
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
165 # The name of an image file (relative to this directory) to place at the top
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
166 # of the sidebar.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
167 #html_logo = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
168
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
169 # The name of an image file (within the static path) to use as favicon of the
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
170 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
171 # pixels large.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
172 #html_favicon = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
173
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
174 # Add any paths that contain custom static files (such as style sheets) here,
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
175 # relative to this directory. They are copied after the builtin static files,
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
176 # so a file named "default.css" will overwrite the builtin "default.css".
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
177 html_static_path = ['_static']
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
178
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
179 # Add any extra paths that contain custom files (such as robots.txt or
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
180 # .htaccess) here, relative to this directory. These files are copied
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
181 # directly to the root of the documentation.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
182 html_extra_path = ['html_extra']
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
183
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
184 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
185 # using the given strftime format.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
186 html_last_updated_fmt = '%b %d, %Y'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
187
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
188 # If true, SmartyPants will be used to convert quotes and dashes to
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
189 # typographically correct entities.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
190 #html_use_smartypants = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
191
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
192 # Custom sidebar templates, maps document names to template names.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
193 #html_sidebars = {}
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
194
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
195 # Additional templates that should be rendered to pages, maps page names to
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
196 # template names.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
197 #html_additional_pages = {}
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
198
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
199 # If false, no module index is generated.
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
200 #html_domain_indices = True
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
201
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
202 # If false, no index is generated.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
203 #html_use_index = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
204
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
205 # If true, the index is split into individual pages for each letter.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
206 #html_split_index = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
207
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
208 # If true, links to the reST sources are added to the pages.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
209 #html_show_sourcelink = True
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
210
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
211 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
212 #html_show_sphinx = True
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
213
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
214 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
215 #html_show_copyright = True
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
216
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
217 # If true, an OpenSearch description file will be output, and all pages will
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
218 # contain a <link> tag referring to it. The value of this option must be the
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
219 # base URL from which the finished HTML is served.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
220 #html_use_opensearch = ''
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
221
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
222 # This is the file name suffix for HTML files (e.g. ".xhtml").
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
223 #html_file_suffix = None
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
224
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
225 # Language to be used for generating the HTML full-text search index.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
226 # Sphinx supports the following languages:
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
227 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
228 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
229 #html_search_language = 'en'
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
230
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
231 # A dictionary with options for the search language support, empty by default.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
232 # Now only 'ja' uses this config value
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
233 #html_search_options = {'type': 'default'}
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
234
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
235 # The name of a javascript file (relative to the configuration directory) that
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
236 # implements a search results scorer. If empty, the default will be used.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
237 #html_search_scorer = 'scorer.js'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
238
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
239 # Output file base name for HTML help builder.
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
240 htmlhelp_basename = 'roundupdoc'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
241
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
242 # -- Options for LaTeX output ---------------------------------------------
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
243
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
244 latex_elements = {
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
245 # The paper size ('letterpaper' or 'a4paper').
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
246 #'papersize': 'letterpaper',
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
247
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
248 # The font size ('10pt', '11pt' or '12pt').
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
249 #'pointsize': '10pt',
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
250
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
251 # Additional stuff for the LaTeX preamble.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
252 #'preamble': '',
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
253
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
254 # Latex figure (float) alignment
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
255 #'figure_align': 'htbp',
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
256 }
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
257
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
258 # Grouping the document tree into LaTeX files. List of tuples
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
259 # (source start file, target name, title,
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
260 # author, documentclass [howto, manual, or own class]).
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
261 latex_documents = [
4357
13b3155869e0 Beginnings of a big code cleanup / modernisation to make 2to3 happy
Richard Jones <richard@users.sourceforge.net>
parents: 4033
diff changeset
262 ('docs/index', 'Roundup.tex', u'Roundup Documentation',
13b3155869e0 Beginnings of a big code cleanup / modernisation to make 2to3 happy
Richard Jones <richard@users.sourceforge.net>
parents: 4033
diff changeset
263 u'Richard Jones', 'manual'),
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
264 ]
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
265
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
266 # The name of an image file (relative to this directory) to place at the top of
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
267 # the title page.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
268 #latex_logo = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
269
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
270 # For "manual" documents, if this is true, then toplevel headings are parts,
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
271 # not chapters.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
272 #latex_use_parts = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
273
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
274 # If true, show page references after internal links.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
275 #latex_show_pagerefs = False
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
276
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
277 # If true, show URL addresses after external links.
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
278 #latex_show_urls = False
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
279
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
280 # Documents to append as an appendix to all manuals.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
281 #latex_appendices = []
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
282
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
283 # If false, no module index is generated.
5029
333b01621772 Preparing 1.5.1 steps 7/16
anatoly techtonik <techtonik@gmail.com>
parents: 5028
diff changeset
284 #latex_domain_indices = True
Roundup Issue Tracker: http://roundup-tracker.org/