Mercurial > p > roundup > code

annotate website/www/conf.py @ 6666:54af7ce65e6e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add canonical url link in header Add canonical url to all pages. Requires upgrade to at least 1.8.0 of sphinx. Upgraded virualenv on sourceforge to have sphinx 1.8.5 to allow it to work. Hand patched the files on sourceforge and deployed. Also added a postprocess step to Makefile needed on sourceforge to load searchtools.js.
author John Rouillard <rouilj@ieee.org>
date Mon, 09 May 2022 19:57:16 -0400
parents cbc18a8bc61f
children 5855a6a26bdd
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.
6263
3a851df879cd Remove doc dependency sphinxcontrib-cheeseshop.
John Rouillard <rouilj@ieee.org>
parents: 6225
diff changeset
32 # extensions = ['sphinxcontrib.cheeseshop']
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
33
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
34 # Add any paths that contain templates here, relative to this directory.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
35 templates_path = ['_templates']
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 # The suffix of source filenames.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
38 source_suffix = '.txt'
4022
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 encoding of source files.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
41 #source_encoding = 'utf-8'
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 master toctree document.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
44 master_doc = 'contents'
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 # General information about the project.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
47 project = u'Roundup'
6439
5296d27ac97c Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
48 copyright = u'2009-2021, Richard Jones, Roundup-Team'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
49
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
50 # 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
51 # |version| and |release|, also used in various other places throughout the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
52 # built documents.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
53 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
54 # The short X.Y version.
6439
5296d27ac97c Implementing RELEASE.txt 2.1.0b1 release
John Rouillard <rouilj@ieee.org>
parents: 6370
diff changeset
55 version = '2.1'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
56 # The full version, including alpha/beta/rc tags.
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
57 release = '2.1.0'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
58
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
59 # The language for content autogenerated by Sphinx. Refer to documentation
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
60 # for a list of supported languages.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
61 #language = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
62
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
63 # 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
64 # non-false value, then it is used:
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
65 #today = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
66 # 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
67 #today_fmt = '%B %d, %Y'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
68
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
69 # 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
70 exclude_patterns = ['docs/index.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
71 'docs/whatsnew-0.7.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
72 'docs/whatsnew-0.8.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
73 'docs/security.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
74 '_tmp']
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
75
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
76 # 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
77 #default_role = None
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 # If true, '()' will be appended to :func: etc. cross-reference text.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
80 #add_function_parentheses = True
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, the current module name will be prepended to all description
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
83 # unit titles (such as .. function::).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
84 #add_module_names = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
85
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
86 # If true, sectionauthor and moduleauthor directives will be shown in the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
87 # output. They are ignored by default.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
88 #show_authors = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
89
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
90 # The name of the Pygments (syntax highlighting) style to use.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
91 pygments_style = 'sphinx'
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
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
94 # Options for HTML output
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 # 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
98 # 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
99 # given in html_static_path.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
100 html_style = 'default.css'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
101
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
102 # 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
103 # "<project> v<release> documentation".
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
104 #html_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
105
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
106 # 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
107 #html_short_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
108
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
109 # 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
110 # 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
111 html_baseurl = "https://www.roundup-tracker.org/"
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
112
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
113 # 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
114 # of the sidebar.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
115 #html_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
116
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
117 # 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
118 # 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
119 # pixels large.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
120 #html_favicon = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
121
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
122 # 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
123 # 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
124 # 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
125 html_static_path = ['_static']
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
126
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
127 # 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
128 # using the given strftime format.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
129 html_last_updated_fmt = '%b %d, %Y'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
130
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
131 # 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
132 # typographically correct entities.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
133 #html_use_smartypants = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
134
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
135 # Custom sidebar templates, maps document names to template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
136 #html_sidebars = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
137
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
138 html_collapse_toctree = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
139
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
140 # 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
141 # template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
142 #html_additional_pages = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
143
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
144 html_add_permalinks = ''
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
145
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
146 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
147 #html_use_modindex = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
148
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
149 # If false, no index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
150 #html_use_index = 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 # 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
153 #html_split_index = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
154
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
155 # 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
156 #html_copy_source = True
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 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
159 # 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
160 # base URL from which the finished HTML is served.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
161 #html_use_opensearch = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
162
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
163 # 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
164 #html_file_suffix = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
165
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
166 # Output file base name for HTML help builder.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
167 htmlhelp_basename = 'Roundupdoc'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
168
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 # Options for LaTeX output
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
171 # ------------------------
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
172
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
173 # The paper size ('letter' or 'a4').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
174 #latex_paper_size = 'letter'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
175
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
176 # The font size ('10pt', '11pt' or '12pt').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
177 #latex_font_size = '10pt'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
178
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
179 # Grouping the document tree into LaTeX files. List of tuples
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
180 # (source start file, target name, title, author, document class [howto/manual]).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
181 latex_documents = [
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
182 ('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
183 u'Richard Jones', 'manual'),
4022
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
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
186 # 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
187 # the title page.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
188 #latex_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
189
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
190 # 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
191 # not chapters.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
192 #latex_use_parts = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
193
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
194 # Additional stuff for the LaTeX preamble.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
195 #latex_preamble = ''
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 # Documents to append as an appendix to all manuals.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
198 #latex_appendices = []
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
199
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
200 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
201 #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
202
e6bee80c20f8 Ignore localhost links and ignore www.zope.org links as they are in
John Rouillard <rouilj@ieee.org>
parents: 5634
diff changeset
203
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
204 linkcheck_ignore = [
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
205 r'https?://.*localhost:\d+/',
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
206 r'http://www.zope.com/Marks', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
207 r'http://www.ekit.com/', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
208 r'http://www.bizarsoftware.com.au/', # reference in license,
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
209 r'http://11.11.11.101', # dummy example url
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
210 r'https://.../rest/.*', # dummy example url
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
211 r'http://myroundup.com/roundup.*', # dummy example url
6456
cbc18a8bc61f Changes for release of version 2.1.0.
John Rouillard <rouilj@ieee.org>
parents: 6439
diff changeset
212 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
213 ]
Roundup Issue Tracker: http://roundup-tracker.org/