diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2019-08-11 16:06:00 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2019-08-11 16:06:00 -0400 |
| commit | f2a778b3aa18de0bd43b1ba1a144d16faa53b8a2 (patch) | |
| tree | 6b78e22c1f5a2e827bba40a33bd642c1e7b38f63 /doc | |
| parent | 1a27df4c768e5a183ddd0f890d139996ffc52778 (diff) | |
| download | python-coveragepy-git-f2a778b3aa18de0bd43b1ba1a144d16faa53b8a2.tar.gz | |
Improve doc tooling
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 13 | ||||
| -rw-r--r-- | doc/requirements.pip | 4 |
2 files changed, 12 insertions, 5 deletions
diff --git a/doc/conf.py b/doc/conf.py index 28ec17f4..836f77c9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -2,7 +2,8 @@ # Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 # For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt -# +"""Sphinx configuration.""" + # coverage.py documentation build configuration file, created by # sphinx-quickstart on Wed May 13 22:18:33 2009. # @@ -14,7 +15,7 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +import os # 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 @@ -33,6 +34,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinxcontrib.spelling', + 'sphinx.ext.intersphinx', ] # Add any paths that contain templates here, relative to this directory. @@ -49,7 +51,7 @@ master_doc = 'index' # General information about the project. project = u'Coverage.py' -copyright = u'2009\N{EN DASH}2019, Ned Batchelder.' # CHANGEME +copyright = u'2009\N{EN DASH}2019, Ned Batchelder.' # CHANGEME # pylint: disable=redefined-builtin # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -97,6 +99,10 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] +intersphinx_mapping = { + 'python': ('https://docs.python.org/3', None), + } + # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with @@ -189,6 +195,7 @@ autoclass_content = "class" prerelease = bool(max(release).isalpha()) def setup(app): + """Configure Sphinx""" app.add_stylesheet('coverage.css') app.add_config_value('prerelease', False, 'env') print("** Prerelease = %r" % prerelease) diff --git a/doc/requirements.pip b/doc/requirements.pip index 7c9f9067..3f864737 100644 --- a/doc/requirements.pip +++ b/doc/requirements.pip @@ -4,6 +4,6 @@ doc8==0.8.0 pyenchant==2.0.0 -sphinx==2.0.1 -sphinxcontrib-spelling==4.2.1 +sphinx==2.1.2 +sphinxcontrib-spelling==4.3.0 sphinx_rtd_theme==0.4.3 |