conf.py - Sphinx configuration for generating CodeChat’s documentation¶

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.

Use the CodeChat version date in its generated documentation.

import CodeChat

Import the Alabaster theme customizations.

import alabaster

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 = 'CodeChat'
copyright = '2016, 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 = CodeChat.__version__

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

release = 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 = 'python'
 

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. CodeChat note: CodeChat has been tested with Sphinx 1.1 and above. Older versions may or may not work.

needs_sphinx = '1.3'
 

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', 'alabaster']
 

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

templates_path = ['_templates']
 

source_suffix: The suffix of source filenames. Add .in and .spec files (see below).

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.

CodeChat_lexer_for_glob = {

CodeChat.css is auto-detected as a CSS + Lasso file by Pygments, causing it to display incorrectly. Define it as CSS only, both in the root path and in the template subdirectory.

    'CodeChat.css': 'CSS',

The MANIFEST.in files uses # as a comment. So does Python. Ugly, no?

    'MANIFEST.in'  : 'Python',
    }
 

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.

exclude_patterns = [

Ignore Mercurial repo.

                    '.hg',

Ignore setup.py output.

                    'build',
                    'dist',
                    'CodeChat.egg-info',

Ignore Sphinx output.

                    '_build',

Ignore this file’s output.

                    'sphinx-enki-info.txt',

Ignore file from external web site.

                    'ez_setup.py',

Ignore HTML – the license and test output.

                    '**.html',
                    ]
 

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

##default_role = None

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 = 'alabaster'
 

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. Set this per the Alabaster theme customizations.

html_theme_path = [alabaster.get_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_use_smartypants: If true, SmartyPants will be used to convert quotes and dashes to typographically correct entities.

html_use_smartypants = True
 

html_sidebars: Custom sidebar templates, maps document names to template names. Set this per the Alabaster theme customizations.

html_sidebars = {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',
        'searchbox.html',
        'donate.html',
    ]
}
 

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_show_sourcelink: If true, links to the reST sources are added to the pages.

html_show_sourcelink = True
 

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

conf.py - Sphinx configuration for generating CodeChat’s documentation¶

Project information ¶

General configuration ¶

Options for HTML output ¶

CodeChat

Navigation

Related Topics

conf.py - Sphinx configuration for generating CodeChat’s documentation¶

Project information¶

General configuration¶

Options for HTML output¶

Project information ¶

General configuration ¶

Options for HTML output ¶