Mercurial > p > roundup > code

annotate website/www/conf.py @ 7502:5bac0a0afb7f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Eliminate error w/ permalink setting for sphinx 5+; enable opesearch opensearch enabled for website build only. Not local docs.
author John Rouillard <rouilj@ieee.org>
date Tue, 20 Jun 2023 00:53:39 -0400
parents 06a2f79389b6
children 4376d8c19b2a
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
7468
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
22 # Read Roundup version by importing it from root of checkout.
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
23 # this ensures that 'unknown version' is inserted even if
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
24 # `roundup` is importable from other location in sys.path
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
25 SYSSAVE = sys.path
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
26 DOCROOT = os.path.abspath(os.path.dirname(__file__) + "/..")
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
27 sys.path = [os.path.dirname(DOCROOT)]
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
28 try:
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
29 from roundup import __version__ as VERSION
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
30 SHORTVER = '.'.join(VERSION.split('.', 2)[:2])
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
31 except ImportError:
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
32 VERSION = SHORTVER = '(unknown version)'
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
33 finally:
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
34 sys.path = SYSSAVE
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
35
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
36 # 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
37 # 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
38 # absolute, like shown here.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
39 #sys.path.append(os.path.abspath('.'))
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
40
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
41 # General configuration
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
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
44 # 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
45 # 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
46 extensions = ['sphinx_sitemap']
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
47
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
48 # 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
49 sitemap_url_scheme = "{link}"
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
50
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
51 # Add any paths that contain templates here, relative to this directory.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
52 templates_path = ['_templates']
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 suffix of source filenames.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
55 source_suffix = '.txt'
4022
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 encoding of source files.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
58 #source_encoding = 'utf-8'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
59
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
60 # The master toctree document.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
61 master_doc = 'contents'
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 # General information about the project.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
64 project = u'Roundup'
7342
42a2ae439705 update copyright end date.
John Rouillard <rouilj@ieee.org>
parents: 7134
diff changeset
65 copyright = u'2009-2023, Richard Jones, Roundup-Team'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
66
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
67 # 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
68 # |version| and |release|, also used in various other places throughout the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
69 # built documents.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
70 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
71 # The short X.Y version.
7468
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
72 version = SHORTVER
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
73 # The full version, including alpha/beta/rc tags.
7468
f100f5fdf6bf Autmatically get version and release from roundup/__init__.py
John Rouillard <rouilj@ieee.org>
parents: 7443
diff changeset
74 release = VERSION
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 language for content autogenerated by Sphinx. Refer to documentation
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
77 # for a list of supported languages.
7493
06a2f79389b6 Set language to en explicitly.
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
78 language = 'en'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
79
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
80 # 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
81 # non-false value, then it is used:
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
82 #today = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
83 # 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
84 #today_fmt = '%B %d, %Y'
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 # 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
87 exclude_patterns = ['docs/index.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
88 'docs/whatsnew-0.7.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
89 'docs/whatsnew-0.8.txt',
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
90 'robots.txt',
7371
a210f4437b49 Incomplete work to generate config doc from config.ini
John Rouillard <rouilj@ieee.org>
parents: 7342
diff changeset
91 'docs/tracker_config.txt',
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
92 '_tmp']
4022
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 # 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
95 #default_role = None
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 # If true, '()' will be appended to :func: etc. cross-reference text.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
98 #add_function_parentheses = True
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 # 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
101 # unit titles (such as .. function::).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
102 #add_module_names = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
103
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
104 # If true, sectionauthor and moduleauthor directives will be shown in the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
105 # output. They are ignored by default.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
106 #show_authors = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
107
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
108 # 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
109 pygments_style = 'borland'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
110
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
111
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
112 # Options for HTML output
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
113 # -----------------------
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
114
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
115 # 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
116 # 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
117 # given in html_static_path.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
118 html_style = 'default.css'
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 for this set of Sphinx documents. If None, it defaults to
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
121 # "<project> v<release> documentation".
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
122 #html_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
123
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
124 # 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
125 #html_short_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
126
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
127 # 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
128 # 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
129 html_baseurl = "https://www.roundup-tracker.org/"
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
130
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
131 # 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
132 # of the sidebar.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
133 #html_logo = None
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 # 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
136 # 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
137 # pixels large.
6783
8291903b825a fix icon path.
John Rouillard <rouilj@ieee.org>
parents: 6779
diff changeset
138 html_favicon = '_static/favicon.ico'
4022
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 # 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
141 # 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
142 # 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
143 html_static_path = ['_static']
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
144
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
145 # 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
146 # using the given strftime format.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
147 html_last_updated_fmt = '%b %d, %Y'
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 true, SmartyPants will be used to convert quotes and dashes to
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
150 # typographically correct entities.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
151 #html_use_smartypants = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
152
6667
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
153 # 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
154 # 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
155 # 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
156 # 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
157 # same name.
6779
d669f96dc580 www: add favicon, opensearch
John Rouillard <rouilj@ieee.org>
parents: 6773
diff changeset
158 # 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
159 # 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
160 # 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
161
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
162 # Custom sidebar templates, maps document names to template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
163 #html_sidebars = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
164
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
165 html_collapse_toctree = True
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 # 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
168 # template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
169 #html_additional_pages = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
170
7492
452a8bd1d826 add file with sphinx requirements for building doc.
John Rouillard <rouilj@ieee.org>
parents: 7468
diff changeset
171 # disable permalinks
7502
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
172 from sphinx import version_info
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
173 if version_info < (3,5,0):
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
174 html_add_permalinks = ''
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
175 else:
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
176 html_permalinks = False # when sphinx > 3.5 is used.
4022
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 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
179 #html_use_modindex = True
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 # If false, no index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
182 #html_use_index = True
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 # 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
185 #html_split_index = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
186
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
187 # 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
188 #html_copy_source = True
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 # 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
191 # 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
192 # base URL from which the finished HTML is served.
7502
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
193 html_use_opensearch = html_baseurl
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
194
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
195 # 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
196 #html_file_suffix = ''
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 # Output file base name for HTML help builder.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
199 htmlhelp_basename = 'Roundupdoc'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
200
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 # Options for LaTeX output
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
203 # ------------------------
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
204
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
205 # The paper size ('letter' or 'a4').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
206 #latex_paper_size = 'letter'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
207
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
208 # The font size ('10pt', '11pt' or '12pt').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
209 #latex_font_size = '10pt'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
210
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
211 # Grouping the document tree into LaTeX files. List of tuples
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
212 # (source start file, target name, title, author, document class [howto/manual]).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
213 latex_documents = [
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
214 ('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
215 u'Richard Jones', 'manual'),
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
216 ]
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
217
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
218 # 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
219 # the title page.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
220 #latex_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
221
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
222 # 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
223 # not chapters.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
224 #latex_use_parts = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
225
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
226 # Additional stuff for the LaTeX preamble.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
227 #latex_preamble = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
228
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
229 # Documents to append as an appendix to all manuals.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
230 #latex_appendices = []
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
231
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
232 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
233 #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
234
e6bee80c20f8 Ignore localhost links and ignore www.zope.org links as they are in
John Rouillard <rouilj@ieee.org>
parents: 5634
diff changeset
235
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
236 linkcheck_ignore = [
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
237 r'https?://.*localhost:\d+/',
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
238 r'http://www.zope.com/Marks', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
239 r'http://www.ekit.com/', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
240 r'http://www.bizarsoftware.com.au/', # reference in license,
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
241 r'http://11.11.11.101', # dummy example url
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
242 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
243 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
244 ]
Roundup Issue Tracker: http://roundup-tracker.org/