Mercurial > p > roundup > code

annotate doc/conf.py @ 4955:2d83625e1c06

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Synchronize conf.py between doc/ and website/www/
author anatoly techtonik <techtonik@gmail.com>
date Sat, 13 Dec 2014 19:17:10 +0300
parents b26176334c88
children 46b7d1ee4fab
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 #
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
12 # This file is execfile()d with the current directory set to its containing dir.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
13 #
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
14 # The contents of this file are pickled, so don't put values in the namespace
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
15 # that aren't pickleable (module imports are okay, they're removed automatically).
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
16 #
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
17 # All configuration values have a default; values that are commented out
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
18 # serve to show the default.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
19
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
20 import sys, os
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
21
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
22
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
23 # Read Roundup version by importing it from parent directory,
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
24 # this ensures that 'unkown version' is inserted even if
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
25 # `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
26 SYSSAVE = sys.path
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
27 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
28 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
29 try:
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
30 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
31 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
32 except ImportError:
4837
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
33 VERSION = SHORTVER = '(unknown version)'
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
34 finally:
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
35 sys.path = SYSSAVE
bf786562ba7f doc/conf.py: Clear sys.path before importing Roundup __version__
anatoly techtonik <techtonik@gmail.com>
parents: 4832
diff changeset
36
4832
76460d14be91 Read version and release for generated documentation from roundup/__init__.py
Thomas Arendsen Hein <thomas@intevation.de>
parents: 4357
diff changeset
37
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
38 # If your extensions are in another directory, add it here. If the directory
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
39 # is relative to the documentation root, use os.path.abspath to make it
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
40 # absolute, like shown here.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
41 #sys.path.append(os.path.abspath('.'))
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
42
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
43 # General configuration
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
44 # ---------------------
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
45
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
46 # Add any Sphinx extension module names here, as strings. They can be extensions
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
47 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
48 #extensions = ['toctree']
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
49
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
50 # Add any paths that contain templates here, relative to this directory.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
51 templates_path = ['_templates']
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
52
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
53 # The suffix of source filenames.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
54 source_suffix = '.txt'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
55
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
56 # The encoding of source files.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
57 #source_encoding = 'utf-8'
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 # The master toctree document.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
60 master_doc = 'index'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
61
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
62 # General information about the project.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
63 project = u'Roundup'
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4897
diff changeset
64 copyright = u'2009-2015, Richard Jones, Roundup-Team'
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
65
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
66 # 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
67 # |version| and |release|, also used in various other places throughout the
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
68 # built documents.
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 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
71 version = SHORTVER
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
72 # 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
73 release = VERSION
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
74
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
75 # The language for content autogenerated by Sphinx. Refer to documentation
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
76 # for a list of supported languages.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
77 #language = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
78
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
79 # 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
80 # non-false value, then it is used:
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
81 #today = ''
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
82 # Else, today_fmt is used as the format for a strftime call.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
83 #today_fmt = '%B %d, %Y'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
84
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
85 # List of documents that shouldn't be included in the build.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
86 #unused_docs = []
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
87
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
88 # List of directories, relative to source directory, that shouldn't be searched
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
89 # for source files.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
90 exclude_trees = ['.build']
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
91
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
92 # The reST default role (used for this markup: `text`) to use for all documents.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
93 #default_role = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
94
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
95 # If true, '()' will be appended to :func: etc. cross-reference text.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
96 #add_function_parentheses = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
97
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
98 # If true, the current module name will be prepended to all description
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
99 # unit titles (such as .. function::).
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
100 #add_module_names = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
101
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
102 # If true, sectionauthor and moduleauthor directives will be shown in the
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
103 # output. They are ignored by default.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
104 #show_authors = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
105
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
106 # The name of the Pygments (syntax highlighting) style to use.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
107 pygments_style = 'sphinx'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
108
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 # Options for HTML output
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
111 # -----------------------
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 # 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
114 # 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
115 # given in html_static_path.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
116 html_style = 'default.css'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
117
4897
b26176334c88 Fix broken links to static html doc files (issue2550840)
John Kristensen <john@jerrykan.com>
parents: 4837
diff changeset
118 # Add any extra paths that contain custom files (such as robots.txt or
b26176334c88 Fix broken links to static html doc files (issue2550840)
John Kristensen <john@jerrykan.com>
parents: 4837
diff changeset
119 # .htaccess) here, relative to this directory. These files are copied
b26176334c88 Fix broken links to static html doc files (issue2550840)
John Kristensen <john@jerrykan.com>
parents: 4837
diff changeset
120 # directly to the root of the documentation.
b26176334c88 Fix broken links to static html doc files (issue2550840)
John Kristensen <john@jerrykan.com>
parents: 4837
diff changeset
121 html_extra_path = ['html_extra']
b26176334c88 Fix broken links to static html doc files (issue2550840)
John Kristensen <john@jerrykan.com>
parents: 4837
diff changeset
122
4033
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
123 # 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
124 # "<project> v<release> documentation".
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
125 #html_title = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
126
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
127 # 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
128 #html_short_title = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
129
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
130 # 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
131 # of the sidebar.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
132 #html_logo = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
133
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
134 # 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
135 # 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
136 # pixels large.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
137 #html_favicon = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
138
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
139 # 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
140 # relative to this directory. They are copied after the builtin static files,
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
141 # so a file named "default.css" will overwrite the builtin "default.css".
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
142 html_static_path = ['_static']
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
143
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
144 # 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
145 # using the given strftime format.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
146 html_last_updated_fmt = '%b %d, %Y'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
147
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
148 # If true, SmartyPants will be used to convert quotes and dashes to
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
149 # typographically correct entities.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
150 #html_use_smartypants = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
151
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
152 # Custom sidebar templates, maps document names to template names.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
153 #html_sidebars = {}
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
154
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
155 html_collapse_toctree = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
156
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
157 # Additional templates that should be rendered to pages, maps page names to
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
158 # template names.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
159 #html_additional_pages = {}
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
160
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
161 html_add_permalinks = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
162
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
163 # If false, no module index is generated.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
164 #html_use_modindex = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
165
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
166 # If false, no index is generated.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
167 #html_use_index = True
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 # If true, the index is split into individual pages for each letter.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
170 #html_split_index = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
171
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
172 # If true, the reST sources are included in the HTML build as _sources/<name>.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
173 #html_copy_source = True
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
174
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
175 # 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
176 # 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
177 # base URL from which the finished HTML is served.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
178 #html_use_opensearch = ''
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
179
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
180 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
181 #html_file_suffix = ''
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
182
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
183 # Output file base name for HTML help builder.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
184 htmlhelp_basename = 'Roundupdoc'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
185
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
186
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
187 # Options for LaTeX output
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
188 # ------------------------
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
189
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
190 # The paper size ('letter' or 'a4').
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
191 #latex_paper_size = 'letter'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
192
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
193 # The font size ('10pt', '11pt' or '12pt').
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
194 #latex_font_size = '10pt'
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
195
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
196 # Grouping the document tree into LaTeX files. List of tuples
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
197 # (source start file, target name, title, author, document class [howto/manual]).
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
198 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
199 ('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
200 u'Richard Jones', 'manual'),
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
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
203 # 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
204 # the title page.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
205 #latex_logo = None
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
206
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
207 # For "manual" documents, if this is true, then toplevel headings are parts,
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
208 # not chapters.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
209 #latex_use_parts = False
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
210
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
211 # Additional stuff for the LaTeX preamble.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
212 #latex_preamble = ''
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
213
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
214 # Documents to append as an appendix to all manuals.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
215 #latex_appendices = []
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 false, no module index is generated.
bca7c59ac400 Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
diff changeset
218 #latex_use_modindex = True
Roundup Issue Tracker: http://roundup-tracker.org/