conf.py - Configuration file for a Sphinx/CodeChat project¶

This file configures Sphinx, which transforms restructured text (reST) into html. See Sphinx build configuration file docs for more information on the settings below.

This file was originally created by sphinx-quickstart, then modified by hand. Notes on its operation:

This file is execfile()d by Sphinx with the current directory set to its containing dir.
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 os
import sphinx_rtd_theme
import pythonic_sqlalchemy_query
 

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, as shown here.

##sys.path.insert(0, os.path.abspath('.'))

Project information ¶

project and copyright: General information about the project. Change this for your project.

project = 'pythonic_sqlalchemy_query'
copyright = '2017, Bryan A. Jones'
 

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. Change these for your project.

version: The short X.Y version.

version = pythonic_sqlalchemy_query.__version__

release: The full version, including alpha/beta/rc tags.

release = 'version ' + version
 

There are two options for replacing |today|:

1. If you set today to some non-false value, then it is used:

##today = ''

2. Otherwise, today_fmt is used as the format for a strftime call.

##today_fmt = '%B %d, %Y'

highlight_language: The default language to highlight source code in.

highlight_language = 'python3'
 

pygments_style: The style name to use for Pygments highlighting of source code.

pygments_style = 'sphinx'
 

add_function_parentheses: If true, ‘()’ will be appended to :func: etc. cross-reference text.

##add_function_parentheses = True

add_module_names: If true, the current module name will be prepended to all description unit titles (such as .. function::).

##add_module_names = True

show_authors: If true, sectionauthor and moduleauthor directives will be shown in the output. They are ignored by default.

##show_authors = False

modindex_common_prefix: A list of ignored prefixes for module index sorting.

##modindex_common_prefix = []

General configuration ¶

extensions: If your documentation needs a minimal Sphinx version, state it here.

##needs_sphinx = '1.5'

Add any Sphinx extension module names here, as strings. They can be extensions coming with Sphinx (named ‘sphinx.ext.*’) or your custom ones. CodeChat note: The CodeChat.CodeToRestSphinx extension is mandatory; without it, CodeChat will not translate source code to reST and then (via Sphinx) to html.

extensions = ['CodeChat.CodeToRestSphinx']
 

templates_path: Add any paths that contain templates here, relative to this directory.

templates_path = ['_templates']
 

rst_epilog: A string of reStructuredText that will be included at the end of every source file that is read.

rst_epilog = (

Provide a convenient way to refer to a source file’s name.

"""

.. |docname| replace:: :docname:`name`
"""
)
 

source_suffix: The suffix of source filenames.

source_suffix = '.rst'
 

CodeChat note: A dict of {glob, lexer_alias}, which uses lexer_alias (e.g. a lexer’s short name) to analyze any file wihch matches the given glob-style pattern (e.g. glob.

CodeChat_lexer_for_glob = {

CSS files are auto-detected as a CSS + Lasso file by Pygments, causing it to display incorrectly. Define them as CSS only.

    '*.css': 'CSS',

These files use # for comments, so treat them like Python.

    '*.txt': 'Python',
    '*.gitignore': 'Python',
}
 
 

CodeChat note: CodeChat_excludes is a list of exclude_patterns which applies only to source documents; exclude_patterns will exclude the given files from all of Sphinx (for example, files here won’t be included even if they’re mentioned in html_static_path.

CodeChat_excludes = []
 

source_encoding: The encoding of source files.

##source_encoding = 'utf-8-sig'

master_doc: The master toctree document.

master_doc = 'index'
 

language: The language for content autogenerated by Sphinx. Refer to documentation for a list of supported languages.

##language = None

exclude_patterns: List of patterns, relative to source directory, that match files and directories to ignore when looking for source files.

Important: Do NOT add CodeChat.css to this list; this will instruct Sphinx not to copy it to the _static directory, where it is needed to properly lay out CodeChat output. Instead, to exclude it from the documents produced by Sphinx, add it to CodeChat_excludes.

exclude_patterns = [

CodeChat notes:

By default, Enki will instruct Sphinx to place all Sphinx output in _build; this directory should therefore be excluded from the list of source files.

    '_build',

The CodeToRestSphinx extension creates a file named sphinx-enki-info.txt, which should be ignored by Sphinx.

    'sphinx-enki-info.txt',

Python files.

    '*.egg-info',
    'build',
    'dist',
    '__pycache__',
    '.cache',
]
 

default_role: The reST default role (used for this markup: `text`) to use for all documents.

default_role = 'any'
 

keep_warnings: If true, keep warnings as “system message” paragraphs in the built documents. Regardless of this setting, warnings are always written to the standard error stream when sphinx-build is run. CodeChat note: This should always be True; doing so places warnings next to the offending text in the web view, making them easy to find and fix.

keep_warnings = True

Options for HTML output ¶

html_theme: The theme to use for HTML and HTML Help pages.

html_theme = 'sphinx_rtd_theme'
 

html_theme_options: Theme options are theme-specific and customize the look and feel of a theme further.

##html_theme_options = {}

html_style: The style sheet to use for HTML pages.

##html_style = None

html_theme_path: Add any paths that contain custom themes here, relative to this directory.

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 

html_title: The name for this set of Sphinx documents. If None, it defaults to <project> v<release> documentation.

##html_title = None

html_short_title: A shorter title for the navigation bar. Default is the same as html_title.

##html_short_title = None

html_logo: The name of an image file (relative to this directory) to place at the top of the sidebar.

##html_logo = None

html_favicon: 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

html_static_path: 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. CodeChat note: This must always include CodeChat.css.

html_static_path = ['CodeChat.css']
 

html_last_updated_fmt: 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'
 

html_sidebars: Custom sidebar templates, maps document names to template names.

##html_sidebars = {}

html_additional_pages: Additional templates that should be rendered to pages, maps page names to template names.

##html_additional_pages = {}

html_domain_indices: If false, no module index is generated.

##html_domain_indices = True

html_use_index: If false, no index is generated.

##html_use_index = True

html_split_index: If true, the index is split into individual pages for each letter.

##html_split_index = False

html_copy_source: If true, the reST sources are included in the HTML build as _sources/name.

html_copy_source = True
 

html_show_sourcelink: If true, links to the reST sources are added to the pages.

html_show_sourcelink = True
 

html_sourcelink_suffix: Suffix to be appended to source links (see html_show_sourcelink), unless they have this suffix already.

html_sourcelink_suffix = ''
 

html_show_sphinx: If true, “Created using Sphinx” is shown in the HTML footer. Default is True.

##html_show_sphinx = True

html_show_copyright: If true, “(C) Copyright …” is shown in the HTML footer. Default is True.

##html_show_copyright = True

html_use_opensearch: 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 = ''

html_file_suffix: This is the file name suffix for HTML files (e.g. “.xhtml”).

##html_file_suffix = None

###########################################################################

auto-created readthedocs.org specific configuration #

###########################################################################

The following code was added during an automated build on readthedocs.org It is auto created and injected for every build. The result is based on the conf.py.tmpl file found in the readthedocs.org codebase: https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl

 
import sys
import os.path
from six import string_types

from sphinx import version_info

Get suffix for proper linking to GitHub This is deprecated in Sphinx 1.3+, as each page can have its own suffix

if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    else:
        SUFFIX = source_suffix[0]
else:
    SUFFIX = '.rst'
 

Add RTD Static Path. Add to the end because it overwrites previous files.

if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')
html_static_path.append('/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static')
 

Add RTD Theme only if they aren’t overriding it already

using_rtd_theme = False
if 'html_theme' in globals():
    if html_theme in ['default']:

Allow people to bail with a hack of having an html_style

        if not 'html_style' in globals():
            import sphinx_rtd_theme
            html_theme = 'sphinx_rtd_theme'
            html_style = None
            html_theme_options = {}
            if 'html_theme_path' in globals():
                html_theme_path.append(sphinx_rtd_theme.get_html_theme_path())
            else:
                html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

            using_rtd_theme = True
else:
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(sphinx_rtd_theme.get_html_theme_path())
    else:
        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    using_rtd_theme = True

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.org/websupport'
    if 'http' not in settings.MEDIA_URL:
        websupport2_static_url = 'https://media.readthedocs.org/static/'
    else:
        websupport2_static_url = 'https://media.readthedocs.org//static'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.org/",
    'PRODUCTION_DOMAIN': "readthedocs.org",
    'versions': [
    ("latest", "/en/latest/"),
    ("stable", "/en/stable/"),
    ],
    'downloads': [
    ("htmlzip", "//readthedocs.org/projects/pythonic-sqlalchemy-query/downloads/htmlzip/latest/"),
    ],
    'subprojects': [
    ],
    'slug': 'pythonic-sqlalchemy-query',
    'name': u'Pythonic SQLAlchemy query',
    'rtd_language': u'en',
    'canonical_url': 'http://pythonic-sqlalchemy-query.readthedocs.io/en/latest/',
    'analytics_code': '',
    'single_version': False,
    'conf_py_path': '/./',
    'api_host': 'https://readthedocs.org',
    'github_user': 'bjones1',
    'github_repo': 'pythonic_sqlalchemy_query',
    'github_version': 'master',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'master',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'master',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-1',

    'commit': '01a71b02',

}




if 'html_context' in globals():
    html_context.update(context)
else:
    html_context = context
 

Add custom RTD extension

if 'extensions' in globals():
    extensions.append("readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

conf.py - Configuration file for a Sphinx/CodeChat project¶

Project information¶

General configuration¶

Options for HTML output¶

Project information ¶

General configuration ¶

Options for HTML output ¶