# -*- coding: utf-8 -*-
#
# python-docx documentation build configuration file, created by
# sphinx-quickstart on Sat Jun 29 17:34:36 2013.
#
# 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 os
import sys
# 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('..'))
from docx import __version__
# -- 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.coverage',
'sphinx.ext.viewcode'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'python-docx'
copyright = u'2013, Steve Canny'
# 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.
#
# The short X.Y version.
version = __version__
# The full version, including alpha/beta/rc tags.
release = __version__
# A string of reStructuredText that will be included at the end of every source
# file that is read. This is the right place to add substitutions that should
# be available in every file.
rst_epilog = """
.. |api-Document| replace:: :class:`docx.api.Document`
.. |AttributeError| replace:: :exc:`.AttributeError`
.. |BaseStyle| replace:: :class:`.BaseStyle`
.. |_Body| replace:: :class:`._Body`
.. |_Cell| replace:: :class:`._Cell`
.. |_CharacterStyle| replace:: :class:`._CharacterStyle`
.. |Cm| replace:: :class:`.Cm`
.. |ColorFormat| replace:: :class:`.ColorFormat`
.. |_Column| replace:: :class:`._Column`
.. |_Columns| replace:: :class:`._Columns`
.. |CoreProperties| replace:: :class:`.CoreProperties`
.. |datetime| replace:: :class:`.datetime.datetime`
.. |Document| replace:: :class:`.Document`
.. |DocumentPart| replace:: :class:`.DocumentPart`
.. |docx| replace:: ``python-docx``
.. |Emu| replace:: :class:`.Emu`
.. |False| replace:: :class:`False`
.. |float| replace:: :class:`.float`
.. |Font| replace:: :class:`.Font`
.. |Inches| replace:: :class:`.Inches`
.. |InlineShape| replace:: :class:`.InlineShape`
.. |InlineShapes| replace:: :class:`.InlineShapes`
.. |InvalidSpanError| replace:: :class:`.InvalidSpanError`
.. |int| replace:: :class:`.int`
.. |_LatentStyle| replace:: :class:`._LatentStyle`
.. |LatentStyles| replace:: :class:`.LatentStyles`
.. |Length| replace:: :class:`.Length`
.. |None| replace:: :class:`.None`
.. |NumberingPart| replace:: :class:`.NumberingPart`
.. |_NumberingStyle| replace:: :class:`._NumberingStyle`
.. |OpcPackage| replace:: :class:`.OpcPackage`
.. |Paragraph| replace:: :class:`.Paragraph`
.. |ParagraphFormat| replace:: :class:`.ParagraphFormat`
.. |_ParagraphStyle| replace:: :class:`._ParagraphStyle`
.. |Part| replace:: :class:`.Part`
.. |Pt| replace:: :class:`.Pt`
.. |_Relationship| replace:: :class:`._Relationship`
.. |Relationships| replace:: :class:`._Relationships`
.. |RGBColor| replace:: :class:`.RGBColor`
.. |_Row| replace:: :class:`._Row`
.. |_Rows| replace:: :class:`._Rows`
.. |Run| replace:: :class:`.Run`
.. |Section| replace:: :class:`.Section`
.. |Sections| replace:: :class:`.Sections`
.. |str| replace:: :class:`.str`
.. |Styles| replace:: :class:`.Styles`
.. |StylesPart| replace:: :class:`.StylesPart`
.. |Table| replace:: :class:`.Table`
.. |_TableStyle| replace:: :class:`._TableStyle`
.. |_Text| replace:: :class:`._Text`
.. |True| replace:: :class:`True`
.. |ValueError| replace:: :class:`ValueError`
"""
# 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 = []
# -- 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 = 'armstrong'
# 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 = ['_themes']
# The name for this set of Sphinx documents. If None, it defaults to
# "