Mercurial > p > roundup > code

annotate website/www/conf.py @ 7134:7109cdf8fef4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Do not hyperlink some exampe url's. The example url's should not be hyperlinked. They show up as dead links in ahrefs etc. Make linkcheck report them if they show up again.
author John Rouillard <rouilj@ieee.org>
date Wed, 15 Feb 2023 10:44:14 -0500
parents 1836e0ef7751
children 42a2ae439705
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
2
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
3 # -- Roundup Notice --
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
4 # This conf.py is used for Roundup website and it is different
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
5 # from doc/conf.py in that it doesn't copy extra HTML files, which
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
6 # are copied manually using instructions in README.txt
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
7 # ---
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
8
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
9 # Roundup documentation build configuration file, created by
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
10 # sphinx-quickstart on Tue Jan 20 17:33:20 2009.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
11 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
12 # This file is execfile()d with the current directory set to its containing dir.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
13 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
14 # The contents of this file are pickled, so don't put values in the namespace
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
15 # that aren't pickleable (module imports are okay, they're removed automatically).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
16 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
17 # All configuration values have a default; values that are commented out
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
18 # serve to show the default.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
19
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
20 import sys, os
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
21
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
22 # If your extensions are in another directory, add it here. If the directory
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
23 # is relative to the documentation root, use os.path.abspath to make it
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
24 # absolute, like shown here.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
25 #sys.path.append(os.path.abspath('.'))
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
26
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
27 # General configuration
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
28 # ---------------------
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
29
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
30 # Add any Sphinx extension module names here, as strings. They can be extensions
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
31 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
6667
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
32 extensions = ['sphinx_sitemap']
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
33
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
34 # for sitemap default: "{lang}{version}subdir/{link}"
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
35 sitemap_url_scheme = "{link}"
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
36
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
37 # Add any paths that contain templates here, relative to this directory.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
38 templates_path = ['_templates']
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
39
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
40 # The suffix of source filenames.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
41 source_suffix = '.txt'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
42
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
43 # The encoding of source files.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
44 #source_encoding = 'utf-8'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
45
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
46 # The master toctree document.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
47 master_doc = 'contents'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
48
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
49 # General information about the project.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
50 project = u'Roundup'
6695
b3ba03d2b214 2.2.0b1 release changes
John Rouillard <rouilj@ieee.org>
parents: 6667
diff changeset
51 copyright = u'2009-2022, Richard Jones, Roundup-Team'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
52
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
53 # The version info for the project you're documenting, acts as replacement for
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
54 # |version| and |release|, also used in various other places throughout the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
55 # built documents.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
56 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
57 # The short X.Y version.
6695
b3ba03d2b214 2.2.0b1 release changes
John Rouillard <rouilj@ieee.org>
parents: 6667
diff changeset
58 version = '2.2'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
59 # The full version, including alpha/beta/rc tags.
6784
502fb803fc22 fix version.
John Rouillard <rouilj@ieee.org>
parents: 6783
diff changeset
60 release = '2.2.0'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
61
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
62 # The language for content autogenerated by Sphinx. Refer to documentation
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
63 # for a list of supported languages.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
64 #language = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
65
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
66 # There are two options for replacing |today|: either, you set today to some
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
67 # non-false value, then it is used:
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
68 #today = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
69 # Else, today_fmt is used as the format for a strftime call.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
70 #today_fmt = '%B %d, %Y'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
71
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
72 # List of documents that shouldn't be included in the build.
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
73 exclude_patterns = ['docs/index.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
74 'docs/whatsnew-0.7.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
75 'docs/whatsnew-0.8.txt',
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
76 'robots.txt',
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
77 '_tmp']
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
78
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
79 # The reST default role (used for this markup: `text`) to use for all documents.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
80 #default_role = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
81
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
82 # If true, '()' will be appended to :func: etc. cross-reference text.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
83 #add_function_parentheses = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
84
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
85 # If true, the current module name will be prepended to all description
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
86 # unit titles (such as .. function::).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
87 #add_module_names = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
88
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
89 # If true, sectionauthor and moduleauthor directives will be shown in the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
90 # output. They are ignored by default.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
91 #show_authors = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
92
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
93 # The name of the Pygments (syntax highlighting) style to use.
6773
339805c4a85b Pygments has poor code block contrast outout using sphinx style.
John Rouillard <rouilj@ieee.org>
parents: 6763
diff changeset
94 pygments_style = 'borland'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
95
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
96
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
97 # Options for HTML output
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
98 # -----------------------
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
99
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
100 # The style sheet to use for HTML and HTML Help pages. A file of that name
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
101 # must exist either in Sphinx' static/ path, or in one of the custom paths
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
102 # given in html_static_path.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
103 html_style = 'default.css'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
104
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
105 # The name for this set of Sphinx documents. If None, it defaults to
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
106 # "<project> v<release> documentation".
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
107 #html_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
108
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
109 # A shorter title for the navigation bar. Default is the same as html_title.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
110 #html_short_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
111
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
112 # The base URL which points to the root of the HTML documentation. It is
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
113 # used to indicate the location of document using The Canonical Link Relation.
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
114 html_baseurl = "https://www.roundup-tracker.org/"
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
115
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
116 # The name of an image file (relative to this directory) to place at the top
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
117 # of the sidebar.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
118 #html_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
119
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
120 # The name of an image file (within the static path) to use as favicon of the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
121 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
122 # pixels large.
6783
8291903b825a fix icon path.
John Rouillard <rouilj@ieee.org>
parents: 6779
diff changeset
123 html_favicon = '_static/favicon.ico'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
124
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
125 # Add any paths that contain custom static files (such as style sheets) here,
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
126 # relative to this directory. They are copied after the builtin static files,
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
127 # so a file named "default.css" will overwrite the builtin "default.css".
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
128 html_static_path = ['_static']
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
129
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
130 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
131 # using the given strftime format.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
132 html_last_updated_fmt = '%b %d, %Y'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
133
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
134 # If true, SmartyPants will be used to convert quotes and dashes to
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
135 # typographically correct entities.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
136 #html_use_smartypants = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
137
6667
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
138 # A list of paths that contain extra files not directly related to the
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
139 # documentation, such as robots.txt or .htaccess. Relative paths are
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
140 # taken as relative to the configuration directory. They are copied to
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
141 # the output directory. They will overwrite any existing file of the
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
142 # same name.
6779
d669f96dc580 www: add favicon, opensearch
John Rouillard <rouilj@ieee.org>
parents: 6773
diff changeset
143 # Warns that robots.txt is not in TOC tree. Causes build to fail with
d669f96dc580 www: add favicon, opensearch
John Rouillard <rouilj@ieee.org>
parents: 6773
diff changeset
144 # sphinx-build -W. So install robots.txt via Makefile.
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
145 # html_extra_path = ['robots.txt']
6667
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
146
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
147 # Custom sidebar templates, maps document names to template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
148 #html_sidebars = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
149
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
150 html_collapse_toctree = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
151
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
152 # Additional templates that should be rendered to pages, maps page names to
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
153 # template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
154 #html_additional_pages = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
155
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
156 html_add_permalinks = ''
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
157
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
158 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
159 #html_use_modindex = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
160
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
161 # If false, no index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
162 #html_use_index = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
163
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
164 # If true, the index is split into individual pages for each letter.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
165 #html_split_index = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
166
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
167 # If true, the reST sources are included in the HTML build as _sources/<name>.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
168 #html_copy_source = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
169
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
170 # If true, an OpenSearch description file will be output, and all pages will
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
171 # contain a <link> tag referring to it. The value of this option must be the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
172 # base URL from which the finished HTML is served.
7088
a93ef7aec24e disable opensearch generation. It doesn't work.
John Rouillard <rouilj@ieee.org>
parents: 6784
diff changeset
173 html_use_opensearch = ''
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
174
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
175 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
176 #html_file_suffix = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
177
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
178 # Output file base name for HTML help builder.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
179 htmlhelp_basename = 'Roundupdoc'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
180
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
181
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
182 # Options for LaTeX output
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
183 # ------------------------
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
184
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
185 # The paper size ('letter' or 'a4').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
186 #latex_paper_size = 'letter'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
187
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
188 # The font size ('10pt', '11pt' or '12pt').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
189 #latex_font_size = '10pt'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
190
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
191 # Grouping the document tree into LaTeX files. List of tuples
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
192 # (source start file, target name, title, author, document class [howto/manual]).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
193 latex_documents = [
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
194 ('docs/index', 'Roundup.tex', u'Roundup Documentation',
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
195 u'Richard Jones', 'manual'),
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
196 ]
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
197
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
198 # The name of an image file (relative to this directory) to place at the top of
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
199 # the title page.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
200 #latex_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
201
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
202 # For "manual" documents, if this is true, then toplevel headings are parts,
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
203 # not chapters.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
204 #latex_use_parts = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
205
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
206 # Additional stuff for the LaTeX preamble.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
207 #latex_preamble = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
208
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
209 # Documents to append as an appendix to all manuals.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
210 #latex_appendices = []
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
211
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
212 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
213 #latex_use_modindex = True
5831
e6bee80c20f8 Ignore localhost links and ignore www.zope.org links as they are in
John Rouillard <rouilj@ieee.org>
parents: 5634
diff changeset
214
e6bee80c20f8 Ignore localhost links and ignore www.zope.org links as they are in
John Rouillard <rouilj@ieee.org>
parents: 5634
diff changeset
215
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
216 linkcheck_ignore = [
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
217 r'https?://.*localhost:\d+/',
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
218 r'http://www.zope.com/Marks', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
219 r'http://www.ekit.com/', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
220 r'http://www.bizarsoftware.com.au/', # reference in license,
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
221 r'http://11.11.11.101', # dummy example url
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
222 r'https://.../rest/.*', # dummy example url
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
223 r'http://dev.zope.org/Wikis/DevSite/Projects/ComponentArchitecture/ZPTInternationalizationSupport', # dead link, there for historic
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
224 ]
Roundup Issue Tracker: http://roundup-tracker.org/