| Index: tools/telemetry/third_party/coverage/doc/conf.py
|
| diff --git a/tools/telemetry/third_party/altgraph/doc/conf.py b/tools/telemetry/third_party/coverage/doc/conf.py
|
| similarity index 72%
|
| copy from tools/telemetry/third_party/altgraph/doc/conf.py
|
| copy to tools/telemetry/third_party/coverage/doc/conf.py
|
| index cd3fd9912ea317d890df3108939f9d3238c9045c..f28a56d9fbce62e04ddd0df83f804090822bd3ac 100644
|
| --- a/tools/telemetry/third_party/altgraph/doc/conf.py
|
| +++ b/tools/telemetry/third_party/coverage/doc/conf.py
|
| @@ -1,7 +1,10 @@
|
| # -*- coding: utf-8 -*-
|
| +# Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0
|
| +# For details: https://bitbucket.org/ned/coveragepy/src/default/NOTICE.txt
|
| +
|
| #
|
| -# altgraph documentation build configuration file, created by
|
| -# sphinx-quickstart on Tue Aug 31 11:04:49 2010.
|
| +# coverage.py documentation build configuration file, created by
|
| +# sphinx-quickstart on Wed May 13 22:18:33 2009.
|
| #
|
| # This file is execfile()d with the current directory set to its containing dir.
|
| #
|
| @@ -13,27 +16,24 @@
|
|
|
| import sys, os
|
|
|
| -def get_version():
|
| - fn = os.path.join(
|
| - os.path.dirname(os.path.dirname(os.path.abspath(__file__))),
|
| - 'setup.cfg')
|
| - for ln in open(fn):
|
| - if ln.startswith('version'):
|
| - version = ln.split('=')[-1].strip()
|
| - return version
|
| -
|
| # 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.append(os.path.abspath('.'))
|
| -sys.path.insert(0,
|
| - os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
| +
|
| +# on_rtd is whether we are on readthedocs.org
|
| +on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
|
|
| # -- General configuration -----------------------------------------------------
|
|
|
| # 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.autodoc' ]
|
| +extensions = [
|
| + 'sphinx.ext.autodoc',
|
| + 'sphinx.ext.todo',
|
| + 'sphinx.ext.ifconfig',
|
| + 'sphinxcontrib.spelling',
|
| +]
|
|
|
| # Add any paths that contain templates here, relative to this directory.
|
| templates_path = ['_templates']
|
| @@ -48,17 +48,17 @@ source_suffix = '.rst'
|
| master_doc = 'index'
|
|
|
| # General information about the project.
|
| -project = u'altgraph'
|
| -copyright = u'2010-2011, Ronald Oussoren, Bob Ippolito, 2004 Istvan Albert'
|
| +project = u'Coverage.py'
|
| +copyright = u'2009\N{EN DASH}2015, Ned Batchelder'
|
|
|
| # 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 = get_version()
|
| +version = '4.0'
|
| # The full version, including alpha/beta/rc tags.
|
| -release = version
|
| +release = '4.0'
|
|
|
| # The language for content autogenerated by Sphinx. Refer to documentation
|
| # for a list of supported languages.
|
| @@ -97,20 +97,33 @@ pygments_style = 'sphinx'
|
| # A list of ignored prefixes for module index sorting.
|
| #modindex_common_prefix = []
|
|
|
| -
|
| # -- Options for HTML output ---------------------------------------------------
|
|
|
| +#html_translator_class = "px_xlator.PxTranslator"
|
| +
|
| # The theme to use for HTML and HTML Help pages. Major themes that come with
|
| # Sphinx are currently 'default' and 'sphinxdoc'.
|
| -html_theme = 'nature'
|
| +#html_theme = 'default'
|
| +
|
| +if not on_rtd: # only import and set the theme if we're building docs locally
|
| + import sphinx_rtd_theme
|
| + html_theme = 'sphinx_rtd_theme'
|
| + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
| +
|
| +# otherwise, readthedocs.org uses their theme by default, so no need to specify it
|
| +
|
|
|
| # 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 = {}
|
|
|
| +#html_style = "neds.css"
|
| +
|
| +#html_add_permalinks = ""
|
| +
|
| # Add any paths that contain custom themes here, relative to this directory.
|
| -#html_theme_path = []
|
| +html_theme_path = ['_templates']
|
|
|
| # The name for this set of Sphinx documents. If None, it defaults to
|
| # "<project> v<release> documentation".
|
| @@ -139,7 +152,7 @@ html_static_path = ['_static']
|
|
|
| # If true, SmartyPants will be used to convert quotes and dashes to
|
| # typographically correct entities.
|
| -#html_use_smartypants = True
|
| +html_use_smartypants = True
|
|
|
| # Custom sidebar templates, maps document names to template names.
|
| #html_sidebars = {}
|
| @@ -149,10 +162,10 @@ html_static_path = ['_static']
|
| #html_additional_pages = {}
|
|
|
| # If false, no module index is generated.
|
| -#html_use_modindex = True
|
| +html_use_modindex = False
|
|
|
| # If false, no index is generated.
|
| -#html_use_index = True
|
| +html_use_index = False
|
|
|
| # If true, the index is split into individual pages for each letter.
|
| #html_split_index = False
|
| @@ -166,44 +179,28 @@ html_show_sourcelink = False
|
| #html_use_opensearch = ''
|
|
|
| # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
| -#html_file_suffix = ''
|
| +#html_file_suffix = '.px'
|
|
|
| # Output file base name for HTML help builder.
|
| -htmlhelp_basename = 'altgraphdoc'
|
| +htmlhelp_basename = 'coveragepydoc'
|
|
|
| +# -- Spelling ---
|
|
|
| -# -- Options for LaTeX output --------------------------------------------------
|
| +spelling_word_list_filename = 'dict.txt'
|
| +spelling_show_suggestions = False
|
|
|
| -# The paper size ('letter' or 'a4').
|
| -#latex_paper_size = 'letter'
|
|
|
| -# The font size ('10pt', '11pt' or '12pt').
|
| -#latex_font_size = '10pt'
|
| +# When auto-doc'ing a class, write the class' docstring and the __init__ docstring
|
| +# into the class docs.
|
| +autoclass_content = "class"
|
|
|
| -# Grouping the document tree into LaTeX files. List of tuples
|
| -# (source start file, target name, title, author, documentclass [howto/manual]).
|
| -latex_documents = [
|
| - ('index', 'altgraph.tex', u'altgraph Documentation',
|
| - u'Ronald Oussoren', 'manual'),
|
| -]
|
|
|
| -# The name of an image file (relative to this directory) to place at the top of
|
| -# the title page.
|
| -#latex_logo = None
|
|
|
| -# For "manual" documents, if this is true, then toplevel headings are parts,
|
| -# not chapters.
|
| -#latex_use_parts = False
|
|
|
| -# Additional stuff for the LaTeX preamble.
|
| -#latex_preamble = ''
|
| -
|
| -# Documents to append as an appendix to all manuals.
|
| -#latex_appendices = []
|
| -
|
| -# If false, no module index is generated.
|
| -#latex_use_modindex = True
|
|
|
| +prerelease = bool(max(release).isalpha())
|
|
|
| -# Example configuration for intersphinx: refer to the Python standard library.
|
| -intersphinx_mapping = {'python': ('http://docs.python.org/', None) }
|
| +def setup(app):
|
| + app.add_stylesheet('coverage.css')
|
| + app.add_config_value('prerelease', False, 'env')
|
| + app.info("** Prerelease = %r" % prerelease)
|
|
|