280 lines
8.8 KiB
Python
280 lines
8.8 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# txaio documentation build configuration file, created by
|
|
# sphinx-quickstart on Wed Mar 18 14:29:26 2015.
|
|
#
|
|
# This file is execfile()d with the current directory set to its
|
|
# containing dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
import sys
|
|
import os
|
|
import shlex
|
|
import time
|
|
|
|
try:
|
|
import sphinx_rtd_theme
|
|
except ImportError:
|
|
sphinx_rtd_theme = None
|
|
|
|
try:
|
|
from sphinxcontrib import spelling
|
|
except ImportError:
|
|
spelling = None
|
|
|
|
|
|
# Monkey patch away WARNING like:
|
|
# "index.rst:4: WARNING: nonlocal image URI found: https://img.shields.io/pypi/v/txaio.svg"
|
|
# see: http://stackoverflow.com/a/28778969
|
|
import sphinx.environment
|
|
from docutils.utils import get_source_line
|
|
|
|
def _warn_node(self, msg, node, **kwargs):
|
|
if not msg.startswith('nonlocal image URI found:'):
|
|
self._warnfunc(msg, '%s:%s' % get_source_line(node))
|
|
|
|
sphinx.environment.BuildEnvironment.warn_node = _warn_node
|
|
|
|
|
|
# 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.
|
|
sys.path.insert(0, os.path.abspath('..'))
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
#needs_sphinx = '1.0'
|
|
|
|
# Check if we are building on readthedocs
|
|
RTD_BUILD = os.environ.get('READTHEDOCS', None) == 'True'
|
|
|
|
# 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.viewcode',
|
|
'sphinx.ext.intersphinx',
|
|
]
|
|
|
|
# extensions not available on RTD
|
|
if spelling is not None:
|
|
extensions.append('sphinxcontrib.spelling')
|
|
|
|
spelling_lang = 'en_US'
|
|
spelling_show_suggestions = False
|
|
spelling_word_list_filename = 'spelling_wordlist.txt'
|
|
|
|
# custom txaio extension configuration
|
|
|
|
autodoc_member_order = 'bysource'
|
|
autodoc_default_flags = ['members', 'show-inheritance', 'undoc-members']
|
|
autoclass_content = 'both'
|
|
|
|
|
|
# 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 encoding of source files.
|
|
#source_encoding = 'utf-8-sig'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'contents'
|
|
|
|
# General information about the project.
|
|
project = u'txaio'
|
|
author = u'Crossbar.io Project'
|
|
this_year = u'{0}'.format(time.strftime('%Y'))
|
|
if this_year != u'2015':
|
|
copyright = u'2015-{0}, Crossbar.io Technologies GmbH'.format(this_year)
|
|
else:
|
|
copyright = u'2015, Crossbar.io Technologies GmbH'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
base_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir))
|
|
with open(os.path.join(base_dir, "txaio", "_version.py")) as f:
|
|
exec(f.read()) # defines __version__
|
|
|
|
version = release = __version__
|
|
|
|
# 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'
|
|
|
|
# There are two options for replacing |today|: either, you set today to some
|
|
# non-false value, then it is used:
|
|
#today = ''
|
|
# Else, today_fmt is used as the format for a strftime call.
|
|
#today_fmt = '%B %d, %Y'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['_build']
|
|
|
|
# The reST default role (used for this markup: `text`) to use for all
|
|
# documents.
|
|
#default_role = None
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
#add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
#add_module_names = True
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
# output. They are ignored by default.
|
|
#show_authors = False
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
#modindex_common_prefix = []
|
|
|
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
|
#keep_warnings = False
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = False
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
if sphinx_rtd_theme:
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
else:
|
|
html_theme = "default"
|
|
|
|
|
|
# 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 themes here, relative to this directory.
|
|
#html_theme_path = []
|
|
|
|
# The name for this set of Sphinx documents. If None, it defaults to
|
|
# "<project> v<release> documentation".
|
|
#html_title = None
|
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
#html_short_title = None
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
# of the sidebar.
|
|
#html_logo = None
|
|
|
|
# The name of an image file (within the static path) to use as favicon of the
|
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
# pixels large.
|
|
#html_favicon = None
|
|
|
|
# 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 = []
|
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or
|
|
# .htaccess) here, relative to this directory. These files are copied
|
|
# directly to the root of the documentation.
|
|
#html_extra_path = []
|
|
|
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
# using the given strftime format.
|
|
#html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
# typographically correct entities.
|
|
#html_use_smartypants = True
|
|
|
|
# Custom sidebar templates, maps document names to template names.
|
|
# Show full, global TOC in sidebar
|
|
# http://stackoverflow.com/a/19007358
|
|
# http://sphinx-doc.org/config.html#confval-html_sidebars
|
|
html_sidebars = {
|
|
'**': [
|
|
'globaltoc.html',
|
|
'relations.html',
|
|
'sourcelink.html',
|
|
'searchbox.html'
|
|
],
|
|
}
|
|
|
|
|
|
# Additional templates that should be rendered to pages, maps page names to
|
|
# template names.
|
|
#html_additional_pages = {}
|
|
|
|
# If false, no module index is generated.
|
|
#html_domain_indices = True
|
|
|
|
# If false, no index is generated.
|
|
#html_use_index = True
|
|
|
|
# If true, the index is split into individual pages for each letter.
|
|
#html_split_index = False
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
#html_show_sourcelink = True
|
|
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
#html_show_sphinx = True
|
|
|
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
#html_show_copyright = True
|
|
|
|
# If true, an OpenSearch description file will be output, and all pages will
|
|
# contain a <link> tag referring to it. The value of this option must be the
|
|
# base URL from which the finished HTML is served.
|
|
#html_use_opensearch = ''
|
|
|
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
#html_file_suffix = None
|
|
|
|
# Language to be used for generating the HTML full-text search index.
|
|
# Sphinx supports the following languages:
|
|
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
|
|
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr'
|
|
#html_search_language = 'en'
|
|
|
|
# A dictionary with options for the search language support, empty by default.
|
|
# Now only 'ja' uses this config value
|
|
#html_search_options = {'type': 'default'}
|
|
|
|
# The name of a javascript file (relative to the configuration directory) that
|
|
# implements a search results scorer. If empty, the default will be used.
|
|
#html_search_scorer = 'scorer.js'
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'txaiodoc'
|
|
|
|
# http://sphinx-doc.org/ext/intersphinx.html
|
|
intersphinx_mapping = {
|
|
'py2': ('http://docs.python.org/2', None),
|
|
'py3': ('http://docs.python.org/3', None),
|
|
'six': ('https://pythonhosted.org/six/', None),
|
|
}
|