annotate website/www/conf.py @ 8044:f9eaaa63fda2

build: update website build to sync built files Sourceforge only supports python 2.7. Newer version of sphinx are required to build docs and they don't work with 2.7. Set up rsync targets that: 1) copy html build directory to sourceforge target directory (dev_docs, production and user home directory) 2) backup existing sourceforge target directory re-sync so it can be served without any missing files. The Makefile now check to see if .orig or *~ files are present in the html build tree. It lists the garbage file and fails if so. Also inserts a .htaccess into the tree to prevent access to: .buildinfo file docs_backup-* files *.orig *~ The first one is a build artifact from newer version of sphinx. The second is the backup directory created with all the original files before a rsync from the local system is done to sourceforge. The backup directory is timestamped with the time of its sync. The last two are probably redundant since make html will fail if they exist. To rollback a sync: move the target directory to a new name. move the backup directory (in the renamed target directory) to the old target directory name. I added the --delete flag to remove files missing from the html directory. Using the -no-times flags will create all new files with the current directory. Using the --backup, --backup-dir flags backs up all replaced/deleted files to backup-dir. The --exclude flag preserves the backup directories on the sourceforge side. Without --exclude the -delete flag would remove these backup-dir's. Note that --delete-exclude must not be used otherwise the backup directories will be deleted.
author John Rouillard <rouilj@ieee.org>
date Wed, 26 Jun 2024 19:11:35 -0400
parents b516483f68a3
children 6d4b5005abf2
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.
8035
b516483f68a3 docs: add opengraph tags to website.
John Rouillard <rouilj@ieee.org>
parents: 8002
diff changeset
46 extensions = ["sphinxext.opengraph", 'sphinx_sitemap', 'sphinx_tabs.tabs',]
7740
67438e439da8 docs: issue2551317 add support for jinja2 customization examples
John Rouillard <rouilj@ieee.org>
parents: 7598
diff changeset
47
67438e439da8 docs: issue2551317 add support for jinja2 customization examples
John Rouillard <rouilj@ieee.org>
parents: 7598
diff changeset
48 sphinx_tabs_valid_builders = ['linkcheck']
67438e439da8 docs: issue2551317 add support for jinja2 customization examples
John Rouillard <rouilj@ieee.org>
parents: 7598
diff changeset
49 sphinx_tabs_disable_tab_closing = True
8035
b516483f68a3 docs: add opengraph tags to website.
John Rouillard <rouilj@ieee.org>
parents: 8002
diff changeset
50 ogp_site_url = "https://www.roundup-tracker.org"
b516483f68a3 docs: add opengraph tags to website.
John Rouillard <rouilj@ieee.org>
parents: 8002
diff changeset
51 ogp_image = "_images/index_logged_out.png"
b516483f68a3 docs: add opengraph tags to website.
John Rouillard <rouilj@ieee.org>
parents: 8002
diff changeset
52 ogp_image_alt = "The front page of a tracker showing a table of issues and their properties."
b516483f68a3 docs: add opengraph tags to website.
John Rouillard <rouilj@ieee.org>
parents: 8002
diff changeset
53 # ogp_description_length = 200
6667
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
54
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
55 # 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
56 sitemap_url_scheme = "{link}"
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
57
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
58 # Add any paths that contain templates here, relative to this directory.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
59 templates_path = ['_templates']
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
60
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
61 # The suffix of source filenames.
4035
e4950073153f Adjust to better sync with roundup docs.
Stefan Seefeld <stefan@users.sourceforge.net>
parents: 4022
diff changeset
62 source_suffix = '.txt'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
63
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
64 # The encoding of source files.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
65 #source_encoding = 'utf-8'
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 master toctree document.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
68 master_doc = 'contents'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
69
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
70 # General information about the project.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
71 project = u'Roundup'
8002
a377590eba34 changes for 2.4.0b0 release
John Rouillard <rouilj@ieee.org>
parents: 7962
diff changeset
72 copyright = u'2009-2024, Richard Jones, Roundup-Team'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
73
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
74 # 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
75 # |version| and |release|, also used in various other places throughout the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
76 # built documents.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
77 #
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
78 # 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
79 version = SHORTVER
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
80 # 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
81 release = VERSION
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
82
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
83 # The language for content autogenerated by Sphinx. Refer to documentation
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
84 # for a list of supported languages.
7493
06a2f79389b6 Set language to en explicitly.
John Rouillard <rouilj@ieee.org>
parents: 7492
diff changeset
85 language = 'en'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
86
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
87 # 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
88 # non-false value, then it is used:
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
89 #today = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
90 # 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
91 #today_fmt = '%B %d, %Y'
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 # 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
94 exclude_patterns = ['docs/index.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
95 'docs/whatsnew-0.7.txt',
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
96 'docs/whatsnew-0.8.txt',
6763
d93b441ee778 Handle build issues, update css for mobile
John Rouillard <rouilj@ieee.org>
parents: 6695
diff changeset
97 'robots.txt',
7371
a210f4437b49 Incomplete work to generate config doc from config.ini
John Rouillard <rouilj@ieee.org>
parents: 7342
diff changeset
98 'docs/tracker_config.txt',
7598
4376d8c19b2a docs: remove COPYING.html from website/www tree.
John Rouillard <rouilj@ieee.org>
parents: 7502
diff changeset
99 'COPYING.txt',
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 6140
diff changeset
100 '_tmp']
4022
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 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
103 #default_role = None
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 # If true, '()' will be appended to :func: etc. cross-reference text.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
106 #add_function_parentheses = True
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 # 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
109 # unit titles (such as .. function::).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
110 #add_module_names = True
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 # If true, sectionauthor and moduleauthor directives will be shown in the
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
113 # output. They are ignored by default.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
114 #show_authors = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
115
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
116 # 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
117 pygments_style = 'borland'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
118
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 # Options for HTML output
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
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
123 # 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
124 # 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
125 # given in html_static_path.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
126 html_style = 'default.css'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
127
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
128 # 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
129 # "<project> v<release> documentation".
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
130 #html_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
131
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
132 # 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
133 #html_short_title = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
134
6666
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
135 # 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
136 # 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
137 html_baseurl = "https://www.roundup-tracker.org/"
54af7ce65e6e Add canonical url link in header
John Rouillard <rouilj@ieee.org>
parents: 6456
diff changeset
138
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
139 # 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
140 # of the sidebar.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
141 #html_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
142
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
143 # 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
144 # 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
145 # pixels large.
6783
8291903b825a fix icon path.
John Rouillard <rouilj@ieee.org>
parents: 6779
diff changeset
146 html_favicon = '_static/favicon.ico'
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
147
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
148 # 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
149 # 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
150 # 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
151 html_static_path = ['_static']
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
152
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
153 # 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
154 # using the given strftime format.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
155 html_last_updated_fmt = '%b %d, %Y'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
156
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
157 # 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
158 # typographically correct entities.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
159 #html_use_smartypants = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
160
6667
5855a6a26bdd Add sitemap to docs. Also add robots.txt to advertize sitemap.
John Rouillard <rouilj@ieee.org>
parents: 6666
diff changeset
161 # 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
162 # 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
163 # 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
164 # 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
165 # same name.
6779
d669f96dc580 www: add favicon, opensearch
John Rouillard <rouilj@ieee.org>
parents: 6773
diff changeset
166 # 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
167 # 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
168 # 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
169
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
170 # Custom sidebar templates, maps document names to template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
171 #html_sidebars = {}
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 html_collapse_toctree = True
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 # 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
176 # template names.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
177 #html_additional_pages = {}
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
178
7492
452a8bd1d826 add file with sphinx requirements for building doc.
John Rouillard <rouilj@ieee.org>
parents: 7468
diff changeset
179 # disable permalinks
7502
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
180 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
181 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
182 html_add_permalinks = ''
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
183 else:
5bac0a0afb7f Eliminate error w/ permalink setting for sphinx 5+; enable opesearch
John Rouillard <rouilj@ieee.org>
parents: 7493
diff changeset
184 html_permalinks = False # when sphinx > 3.5 is used.
4022
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 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
187 #html_use_modindex = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
188
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
189 # If false, no index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
190 #html_use_index = True
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
191
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
192 # 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
193 #html_split_index = False
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 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
196 #html_copy_source = True
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 # 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
199 # 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
200 # 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
201 html_use_opensearch = html_baseurl
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
202
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
203 # 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
204 #html_file_suffix = ''
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 # Output file base name for HTML help builder.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
207 htmlhelp_basename = 'Roundupdoc'
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
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
210 # Options for LaTeX output
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
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
213 # The paper size ('letter' or 'a4').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
214 #latex_paper_size = 'letter'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
215
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
216 # The font size ('10pt', '11pt' or '12pt').
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
217 #latex_font_size = '10pt'
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
218
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
219 # Grouping the document tree into LaTeX files. List of tuples
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
220 # (source start file, target name, title, author, document class [howto/manual]).
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
221 latex_documents = [
4955
2d83625e1c06 Synchronize conf.py between doc/ and website/www/
anatoly techtonik <techtonik@gmail.com>
parents: 4899
diff changeset
222 ('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
223 u'Richard Jones', 'manual'),
4022
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
224 ]
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 # 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
227 # the title page.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
228 #latex_logo = None
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
229
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
230 # 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
231 # not chapters.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
232 #latex_use_parts = False
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
233
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
234 # Additional stuff for the LaTeX preamble.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
235 #latex_preamble = ''
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
236
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
237 # Documents to append as an appendix to all manuals.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
238 #latex_appendices = []
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
239
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
240 # If false, no module index is generated.
d62831da3941 svn repository setup
Stefan Seefeld <stefan@users.sourceforge.net>
parents:
diff changeset
241 #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
242
e6bee80c20f8 Ignore localhost links and ignore www.zope.org links as they are in
John Rouillard <rouilj@ieee.org>
parents: 5634
diff changeset
243
6370
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
244 linkcheck_ignore = [
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
245 r'https?://.*localhost:\d+/',
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
246 r'http://www.zope.com/Marks', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
247 r'http://www.ekit.com/', # reference in license
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
248 r'http://www.bizarsoftware.com.au/', # reference in license,
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
249 r'http://11.11.11.101', # dummy example url
45e8d10a9609 Update links in documentation
John Rouillard <rouilj@ieee.org>
parents: 6263
diff changeset
250 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
251 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
252 ]
7962
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7740
diff changeset
253
828f79ae965b doc: update links and docs on checking links
John Rouillard <rouilj@ieee.org>
parents: 7740
diff changeset
254 linkcheck_timeout = 10 # seconds

Roundup Issue Tracker: http://roundup-tracker.org/