Python/libs/ConfigMix: docs/conf.py annotate

annotate docs/conf.py @ 654:0d6673d06c2c

Add support for using "tomllib" (in Python's stdlib since 3.11) and "tomli" TOML packages. They are preferred if they are found to be installed. But note that the declared dependency for the "toml" extra nevertheless is the "toml" package. Because it is available for all supported Python versions. So use Python 3.11+ or install "tomli" manually if you want to use the alternate packages.

author	Franz Glasner <fzglas.hg@dom66.de>
date	Thu, 19 May 2022 22:10:59 +0200
parents	f454889e41fa
children	77d4a3e7c9e2

rev	line source
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	1 # -- coding: utf-8 --
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	2 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	3 # Configuration file for the Sphinx documentation builder.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	4 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	5 # This file does only contain a selection of the most common options. For a
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	6 # full list see the documentation:
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	7 # http://www.sphinx-doc.org/en/stable/config
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	8
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	9 # -- Path setup --------------------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	10
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	11 # If extensions (or modules to document with autodoc) are in another directory,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	12 # add these directories to sys.path here. If the directory is relative to the
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	13 # documentation root, use os.path.abspath to make it absolute, like shown here.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	14 #
163 ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	15 import datetime
54 aa8345dae995 Generate readable HTML documentation and an API documentation Franz Glasner <hg@dom66.de> parents: 52 diff changeset	16 import os
aa8345dae995 Generate readable HTML documentation and an API documentation Franz Glasner <hg@dom66.de> parents: 52 diff changeset	17 import sys
aa8345dae995 Generate readable HTML documentation and an API documentation Franz Glasner <hg@dom66.de> parents: 52 diff changeset	18 sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	19
57 a3f64253de70 Read the version and release information from the "configmix" package Franz Glasner <hg@dom66.de> parents: 55 diff changeset	20 import configmix
154 28164259aa83 FIX: Build docu with Python: remove all warnings Franz Glasner <hg@dom66.de> parents: 111 diff changeset	21 from configmix.compat import u
57 a3f64253de70 Read the version and release information from the "configmix" package Franz Glasner <hg@dom66.de> parents: 55 diff changeset	22
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	23
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	24 # -- Project information -----------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	25
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	26 project = 'ConfigMix'
593 f454889e41fa Adjust copyright year (the end) to 2022 Franz Glasner <fzglas.hg@dom66.de> parents: 319 diff changeset	27 copyright = u('2015–2022, Franz Glasner. All rights reserved')
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	28 author = 'Franz Glasner'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	29
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	30 # The short X.Y version
57 a3f64253de70 Read the version and release information from the "configmix" package Franz Glasner <hg@dom66.de> parents: 55 diff changeset	31 version = '.'.join(configmix.__version__.split('.')[:2])
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	32 # The full version, including alpha/beta/rc tags
57 a3f64253de70 Read the version and release information from the "configmix" package Franz Glasner <hg@dom66.de> parents: 55 diff changeset	33 release = configmix.__version__
163 ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	34 release_date = configmix.__date__
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	35
163 ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	36 today = datetime.date.today().isoformat()
77 025005f1234f Print the date of the docu more intelligently: use \|today\| together with keyword expansion Franz Glasner <hg@dom66.de> parents: 67 diff changeset	37
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	38
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	39 # -- General configuration ---------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	40
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	41 # If your documentation needs a minimal Sphinx version, state it here.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	42 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	43 # needs_sphinx = '1.0'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	44
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	45 # Add any Sphinx extension module names here, as strings. They can be
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	46 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	47 # ones.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	48 extensions = [
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	49 'sphinx.ext.autodoc',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	50 'sphinx.ext.intersphinx',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	51 'sphinx.ext.todo',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	52 'sphinx.ext.ifconfig',
55 51a8fa011659 Don't show RST file sources and don't show python sources Franz Glasner <hg@dom66.de> parents: 54 diff changeset	53 # 'sphinx.ext.viewcode',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	54 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	55
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	56 # Add any paths that contain templates here, relative to this directory.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	57 templates_path = ['_templates']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	58
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	59 # The suffix(es) of source filenames.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	60 # You can specify multiple suffix as a list of string:
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	61 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	62 # source_suffix = ['.rst', '.md']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	63 source_suffix = '.rst'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	64
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	65 # The master toctree document.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	66 master_doc = 'index'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	67
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	68 # The language for content autogenerated by Sphinx. Refer to documentation
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	69 # for a list of supported languages.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	70 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	71 # This is also used if you do content translation via gettext catalogs.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	72 # Usually you set "language" from the command line for these cases.
67 9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes. Franz Glasner <f.glasner@feldmann-mg.com> parents: 66 diff changeset	73 language = 'en'
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	74
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	75 # List of patterns, relative to source directory, that match files and
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	76 # directories to ignore when looking for source files.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	77 # This pattern also affects html_static_path and html_extra_path .
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	78 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	79
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	80 # The name of the Pygments (syntax highlighting) style to use.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	81 pygments_style = 'sphinx'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	82
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	83
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	84 # -- Options for HTML output -------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	85
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	86 # The theme to use for HTML and HTML Help pages. See the documentation for
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	87 # a list of builtin themes.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	88 #
60 6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation Franz Glasner <hg@dom66.de> parents: 57 diff changeset	89 #html_theme = 'alabaster'
6c5e44dc74db Use the "haiku" theme instead of "alabaster" for the mosly API documentation Franz Glasner <hg@dom66.de> parents: 57 diff changeset	90 html_theme = 'haiku'
159 f7114e4f3938 Adjust the HTML title for the "haiku" theme Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	91 # for the Haiku title
f7114e4f3938 Adjust the HTML title for the "haiku" theme Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	92 html_short_title = u("%s %s") % (project, release)
163 ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	93 html_last_updated_fmt = "%s (rev %s)" % (today, configmix.__revision__)
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	94
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	95 # Theme options are theme-specific and customize the look and feel of a theme
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	96 # further. For a list of options available for each theme, see the
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	97 # documentation.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	98 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	99 # html_theme_options = {}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	100
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	101 # Add any paths that contain custom static files (such as style sheets) here,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	102 # relative to this directory. They are copied after the builtin static files,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	103 # so a file named "default.css" will overwrite the builtin "default.css".
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	104 html_static_path = ['_static']
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	105
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	106 # Custom sidebar templates, must be a dictionary that maps document names
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	107 # to template names.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	108 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	109 # The default sidebars (for documents that don't match any pattern) are
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	110 # defined by theme itself. Builtin themes are using these templates by
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	111 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	112 # 'searchbox.html']``.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	113 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	114 # html_sidebars = {}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	115
55 51a8fa011659 Don't show RST file sources and don't show python sources Franz Glasner <hg@dom66.de> parents: 54 diff changeset	116 html_show_sourcelink = False
51a8fa011659 Don't show RST file sources and don't show python sources Franz Glasner <hg@dom66.de> parents: 54 diff changeset	117
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	118
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	119 # -- Options for HTMLHelp output ---------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	120
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	121 # Output file base name for HTML help builder.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	122 htmlhelp_basename = 'ConfigMixdoc'
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	123
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	124
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	125 # -- Options for LaTeX output ------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	126
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	127 latex_elements = {
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	128 # The paper size ('letterpaper' or 'a4paper').
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	129 #
67 9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes. Franz Glasner <f.glasner@feldmann-mg.com> parents: 66 diff changeset	130 'papersize': 'a4paper',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	131
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	132 # The font size ('10pt', '11pt' or '12pt').
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	133 #
83 7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	134 'pointsize': '11pt',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	135
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	136 # Additional stuff for the LaTeX preamble.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	137 #
83 7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	138 # NOTE: "inconsolata" in "fontpkg" errors within pdfTeX: seems to be
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	139 # incompatible with some header package.
159 f7114e4f3938 Adjust the HTML title for the "haiku" theme Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	140 #
83 7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	141 'preamble': r'''
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	142 \usepackage{inconsolata}
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	143 ''',
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	144
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	145 'fontpkg': r'''
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	146 \usepackage{charter}
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	147 \usepackage[defaultsans]{lato}
159 f7114e4f3938 Adjust the HTML title for the "haiku" theme Franz Glasner <fzglas.hg@dom66.de> parents: 156 diff changeset	148 ''',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	149
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	150 # Latex figure (float) alignment
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	151 #
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	152 # 'figure_align': 'htbp',
67 9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes. Franz Glasner <f.glasner@feldmann-mg.com> parents: 66 diff changeset	153 # Use "Version" instead of "Release" on the title
9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes. Franz Glasner <f.glasner@feldmann-mg.com> parents: 66 diff changeset	154 'releasename': 'Version',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	155 }
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	156
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	157 # Grouping the document tree into LaTeX files. List of tuples
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	158 # (source start file, target name, title,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	159 # author, documentclass [howto, manual, or own class]).
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	160 latex_documents = [
154 28164259aa83 FIX: Build docu with Python: remove all warnings Franz Glasner <hg@dom66.de> parents: 111 diff changeset	161 (master_doc, 'ConfigMix.tex', '"ConfigMix" Documentation',
66 e78f307f81a0 For LaTeX: include documents within the toctree only Franz Glasner <f.glasner@feldmann-mg.com> parents: 65 diff changeset	162 'Franz Glasner', 'manual', True),
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	163 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	164
67 9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes. Franz Glasner <f.glasner@feldmann-mg.com> parents: 66 diff changeset	165 latex_show_urls = 'footnote'
83 7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	166 #latex_show_pagerefs = True
67 9d0d9446de08 Annotate LaTeX output with page numbers and show URL targets in the footnotes. Franz Glasner <f.glasner@feldmann-mg.com> parents: 66 diff changeset	167
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	168
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	169 # -- Options for manual page output ------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	170
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	171 # One entry per manual page. List of tuples
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	172 # (source start file, name, description, authors, manual section).
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	173 man_pages = [
88 5d47693916ee Change title of documentation Franz Glasner <f.glasner@feldmann-mg.com> parents: 83 diff changeset	174 (master_doc, 'configmix', '"ConfigMix" Documentation',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	175 [author], 1)
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	176 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	177
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	178
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	179 # -- Options for Texinfo output ----------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	180
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	181 # Grouping the document tree into Texinfo files. List of tuples
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	182 # (source start file, target name, title, author,
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	183 # dir menu entry, description, category)
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	184 texinfo_documents = [
154 28164259aa83 FIX: Build docu with Python: remove all warnings Franz Glasner <hg@dom66.de> parents: 111 diff changeset	185 (master_doc, 'ConfigMix', '"ConfigMix" Documentation',
47 2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	186 author, 'ConfigMix', 'One line description of project.',
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	187 'Miscellaneous'),
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	188 ]
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	189
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	190
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	191 # -- Extension configuration -------------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	192
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	193 # -- Options for intersphinx extension ---------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	194
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	195 # Example configuration for intersphinx: refer to the Python standard library.
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	196 intersphinx_mapping = {'https://docs.python.org/': None}
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	197
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	198 # -- Options for todo extension ----------------------------------------------
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	199
2ff1e8f02dc7 Running "shinx-quickstart": the automatically generated files as-is Franz Glasner <hg@dom66.de> parents: diff changeset	200 # If true, `todo` and `todoList` produce output, else they produce nothing.
52 6c7f90dbce98 Adjusted the Copyright and change the RCS keywords in accordance with "kwarchive" Franz Glasner <hg@dom66.de> parents: 47 diff changeset	201 todo_include_todos = True
94 2b79ddc0f92b Begin a basic introduction chapter Franz Glasner <hg@dom66.de> parents: 93 diff changeset	202 # Kein Link auf Pfad und Zeile
2b79ddc0f92b Begin a basic introduction chapter Franz Glasner <hg@dom66.de> parents: 93 diff changeset	203 todo_link_only = True
83 7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	204
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	205 # -- Options for autodoc -----------------------------------------------------
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	206
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	207 autodoc_member_order = 'bysource'
7d5b4718ac1b Use the fonts Charter, Lato and Inconsolate within LaTeX. Franz Glasner <hg@dom66.de> parents: 78 diff changeset	208 autoclass_content = 'both'
91 5ca36fbea43d Created a changelog Franz Glasner <hg@dom66.de> parents: 88 diff changeset	209
5ca36fbea43d Created a changelog Franz Glasner <hg@dom66.de> parents: 88 diff changeset	210
163 ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	211 def setup(app):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	212 #
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	213 # Custom release_date variable with a custom substitution \|release_date\|
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	214 #
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	215 app.add_config_value('release_date', '', 'env')
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	216
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	217 import sphinx.transforms
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	218
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	219 class IAMCustomSubstitutions(sphinx.transforms.SphinxTransform):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	220
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	221 default_priority = sphinx.transforms.DefaultSubstitutions.default_priority
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	222 def apply(self):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	223 from docutils import nodes
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	224 for ref in self.document.traverse(nodes.substitution_reference):
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	225 refname = ref['refname']
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	226 if refname == 'release_date':
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	227 stext = self.config[refname]
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	228 ref.replace_self(nodes.Text(stext, stext))
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	229
ff03cdf36139 The README.txt should be in the most important parts readable without keyword substitutions. Franz Glasner <fzglas.hg@dom66.de> parents: 159 diff changeset	230 app.add_transform(IAMCustomSubstitutions)

Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/conf.py @ 654:0d6673d06c2c