Properly encode alleged ascii subjects with non-ascii characters.
[mailman.git] / conf.py
blobf40293c9d094ad0e8fffd871cfe9fba4d117241e
1 # -*- coding: utf-8 -*-
3 # GNU Mailman documentation build configuration file, created by
4 # sphinx-quickstart on Fri Sep 23 21:30:41 2011.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
14 import os
15 import sys
18 # If extensions (or modules to document with autodoc) are in another directory,
19 # add these directories to sys.path here. If the directory is relative to the
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 #sys.path.insert(0, os.path.abspath('.'))
23 # -- General configuration -----------------------------------------------------
25 # If your documentation needs a minimal Sphinx version, state it here.
26 #needs_sphinx = '1.0'
27 sys.path.append(os.path.abspath('_ext'))
29 # Add any Sphinx extension module names here, as strings. They can be extensions
30 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31 extensions = ['sphinx.ext.autodoc',
32 'sphinx.ext.viewcode',
33 'sphinx.ext.graphviz',
34 'sphinxcontrib.zopeext.autointerface',
35 'configplugin',
38 # Add any paths that contain templates here, relative to this directory.
39 # templates_path = ['_templates']
41 # The suffix of source filenames.
42 source_suffix = '.rst'
44 # The encoding of source files.
45 #source_encoding = 'utf-8-sig'
47 # The master toctree document.
48 master_doc = 'README'
50 # General information about the project.
51 project = u'GNU Mailman'
52 copyright = u'1998-2018 by the Free Software Foundation, Inc.'
54 # The version info for the project you're documenting, acts as replacement for
55 # |version| and |release|, also used in various other places throughout the
56 # built documents.
58 # The short X.Y version.
59 import sys; sys.path.append('src')
60 from mailman.version import VERSION
63 version = '.'.join(VERSION.split('.')[0:2])
64 # The full version, including alpha/beta/rc tags.
65 release = VERSION
67 # The language for content autogenerated by Sphinx. Refer to documentation
68 # for a list of supported languages.
69 #language = None
71 # There are two options for replacing |today|: either, you set today to some
72 # non-false value, then it is used:
73 #today = ''
74 # Else, today_fmt is used as the format for a strftime call.
75 #today_fmt = '%B %d, %Y'
77 # List of patterns, relative to source directory, that match files and
78 # directories to ignore when looking for source files.
79 exclude_patterns = ['_build', 'eggs', '.tox', '.pc']
81 # The reST default role (used for this markup: `text`) to use for all documents.
82 #default_role = None
84 # If true, '()' will be appended to :func: etc. cross-reference text.
85 #add_function_parentheses = True
87 # If true, the current module name will be prepended to all description
88 # unit titles (such as .. function::).
89 #add_module_names = True
91 # If true, sectionauthor and moduleauthor directives will be shown in the
92 # output. They are ignored by default.
93 #show_authors = False
95 # The name of the Pygments (syntax highlighting) style to use.
96 pygments_style = 'sphinx'
98 # A list of ignored prefixes for module index sorting.
99 #modindex_common_prefix = []
102 # -- Options for HTML output ---------------------------------------------------
104 # The theme to use for HTML and HTML Help pages. See the documentation for
105 # a list of builtin themes.
106 html_theme = 'sphinx_rtd_theme'
108 # Theme options are theme-specific and customize the look and feel of a theme
109 # further. For a list of options available for each theme, see the
110 # documentation.
111 #html_theme_options = {}
113 # Add any paths that contain custom themes here, relative to this directory.
114 #html_theme_path = []
116 # The name for this set of Sphinx documents. If None, it defaults to
117 # "<project> v<release> documentation".
118 #html_title = None
120 # A shorter title for the navigation bar. Default is the same as html_title.
121 #html_short_title = None
123 # The name of an image file (relative to this directory) to place at the top
124 # of the sidebar.
125 #html_logo = None
127 # The name of an image file (within the static path) to use as favicon of the
128 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129 # pixels large.
130 #html_favicon = None
132 # Add any paths that contain custom static files (such as style sheets) here,
133 # relative to this directory. They are copied after the builtin static files,
134 # so a file named "default.css" will overwrite the builtin "default.css".
135 # html_static_path = ['_static']
137 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138 # using the given strftime format.
139 #html_last_updated_fmt = '%b %d, %Y'
141 # If true, SmartyPants will be used to convert quotes and dashes to
142 # typographically correct entities.
143 #html_use_smartypants = True
145 # Custom sidebar templates, maps document names to template names.
146 #html_sidebars = {}
148 # Additional templates that should be rendered to pages, maps page names to
149 # template names.
150 #html_additional_pages = {}
152 # If false, no module index is generated.
153 #html_domain_indices = True
155 # If false, no index is generated.
156 #html_use_index = True
158 # If true, the index is split into individual pages for each letter.
159 #html_split_index = False
161 # If true, links to the reST sources are added to the pages.
162 #html_show_sourcelink = True
164 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
165 #html_show_sphinx = True
167 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
168 #html_show_copyright = True
170 # If true, an OpenSearch description file will be output, and all pages will
171 # contain a <link> tag referring to it. The value of this option must be the
172 # base URL from which the finished HTML is served.
173 #html_use_opensearch = ''
175 # This is the file name suffix for HTML files (e.g. ".xhtml").
176 #html_file_suffix = None
178 # Output file base name for HTML help builder.
179 htmlhelp_basename = 'GNUMailmandoc'
182 # -- Options for LaTeX output --------------------------------------------------
184 # The paper size ('letter' or 'a4').
185 #latex_paper_size = 'letter'
187 # The font size ('10pt', '11pt' or '12pt').
188 #latex_font_size = '10pt'
190 # Grouping the document tree into LaTeX files. List of tuples
191 # (source start file, target name, title, author, documentclass [howto/manual]).
192 latex_documents = [
193 ('README', 'GNUMailman.tex', u'GNU Mailman Documentation',
194 u'Barry Warsaw', 'manual'),
197 # The name of an image file (relative to this directory) to place at the top of
198 # the title page.
199 #latex_logo = None
201 # For "manual" documents, if this is true, then toplevel headings are parts,
202 # not chapters.
203 #latex_use_parts = False
205 # If true, show page references after internal links.
206 #latex_show_pagerefs = False
208 # If true, show URL addresses after external links.
209 #latex_show_urls = False
211 # Additional stuff for the LaTeX preamble.
212 #latex_preamble = ''
214 # Documents to append as an appendix to all manuals.
215 #latex_appendices = []
217 # If false, no module index is generated.
218 #latex_domain_indices = True
221 autodoc_mock_imports = [
222 "mailman.testing.helpers"
226 # -- Options for manual page output --------------------------------------------
228 # One entry per manual page. List of tuples
229 # (source start file, name, description, authors, manual section).
230 man_pages = [
231 ('README', 'gnumailman', u'GNU Mailman Documentation',
232 [u'Barry Warsaw'], 1)
236 def index_html():
237 import errno
238 cwd = os.getcwd()
239 try:
240 try:
241 os.makedirs('build/sphinx/html')
242 except OSError as error:
243 if error.errno != errno.EEXIST:
244 raise
245 os.chdir('build/sphinx/html')
246 try:
247 os.symlink('README.html', 'index.html')
248 print('index.html -> README.html')
249 except OSError as error:
250 if error.errno != errno.EEXIST:
251 raise
252 finally:
253 os.chdir(cwd)
255 import atexit
258 atexit.register(index_html)