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

comparison docs/conf.py @ 215:ab3d0326419c

Doc: Move the "doc" to "docs"

author	Franz Glasner <fzglas.hg@dom66.de>
date	Wed, 08 May 2019 09:23:37 +0200
parents	doc/conf.py@b5ce9a8461bf
children	13711ba8e81e

comparison

equal deleted inserted replaced

-:a35b0ca8b81f
+:ab3d0326419c
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+# -- Path setup --------------------------------------------------------------
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import datetime
+import os
+import sys
+sys.path.insert(0, os.path.dirname(os.path.abspath('.')))
+import configmix
+from configmix.compat import u
+# -- Project information -----------------------------------------------------
+project = 'ConfigMix'
+copyright = u('2015–2019, Franz Glasner. All rights reserved')
+author = 'Franz Glasner'
+# The short X.Y version
+version = '.'.join(configmix.__version__.split('.')[:2])
+# The full version, including alpha/beta/rc tags
+release = configmix.__version__
+release_date = configmix.__date__
+today = datetime.date.today().isoformat()
+# -- General configuration ---------------------------------------------------
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+'sphinx.ext.autodoc',
+'sphinx.ext.intersphinx',
+'sphinx.ext.todo',
+'sphinx.ext.ifconfig',
+#   'sphinx.ext.viewcode',
+'changelog',
+]
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+# The master toctree document.
+master_doc = 'index'
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+# -- Options for HTML output -------------------------------------------------
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'alabaster'
+html_theme = 'haiku'
+# for the Haiku title
+html_short_title = u("%s %s") % (project, release)
+html_last_updated_fmt = "%s (rev %s)" % (today, configmix.__revision__)
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+html_show_sourcelink = False
+# -- Options for HTMLHelp output ---------------------------------------------
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ConfigMixdoc'
+# -- Options for LaTeX output ------------------------------------------------
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#
+'papersize': 'a4paper',
+# The font size ('10pt', '11pt' or '12pt').
+#
+'pointsize': '11pt',
+# Additional stuff for the LaTeX preamble.
+#
+# NOTE: "inconsolata" in "fontpkg" errors within pdfTeX: seems to be
+#       incompatible with some header package.
+#
+'preamble': r'''
+\usepackage{inconsolata}
+''',
+'fontpkg': r'''
+\usepackage{charter}
+\usepackage[defaultsans]{lato}
+''',
+# Latex figure (float) alignment
+#
+# 'figure_align': 'htbp',
+# Use "Version" instead of "Release" on the title
+'releasename': 'Version',
+}
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+(master_doc, 'ConfigMix.tex', '"ConfigMix" Documentation',
+'Franz Glasner', 'manual', True),
+]
+latex_show_urls = 'footnote'
+#latex_show_pagerefs = True
+# -- Options for manual page output ------------------------------------------
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+(master_doc, 'configmix', '"ConfigMix" Documentation',
+[author], 1)
+]
+# -- Options for Texinfo output ----------------------------------------------
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+(master_doc, 'ConfigMix', '"ConfigMix" Documentation',
+author, 'ConfigMix', 'One line description of project.',
+'Miscellaneous'),
+]
+# -- Extension configuration -------------------------------------------------
+# -- Options for intersphinx extension ---------------------------------------
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+# -- Options for todo extension ----------------------------------------------
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+# Kein Link auf Pfad und Zeile
+todo_link_only = True
+# -- Options for autodoc -----------------------------------------------------
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+# -- Options for changelog ---------------------------------------------------
+changelog_inner_tag_sort = ['breaking', 'feature', 'bugfix', 'misc',
+'test', 'doc']
+def setup(app):
+#
+# Custom release_date variable with a custom substitution |release_date|
+#
+app.add_config_value('release_date', '', 'env')
+import sphinx.transforms
+class IAMCustomSubstitutions(sphinx.transforms.SphinxTransform):
+default_priority = sphinx.transforms.DefaultSubstitutions.default_priority
+def apply(self):
+from docutils import nodes
+for ref in self.document.traverse(nodes.substitution_reference):
+refname = ref['refname']
+if refname == 'release_date':
+stext = self.config[refname]
+ref.replace_self(nodes.Text(stext, stext))
+app.add_transform(IAMCustomSubstitutions)

Mercurial > hgrepos > Python > libs > ConfigMix

comparison docs/conf.py @ 215:ab3d0326419c