Commit 26b75f51 authored by Paul Ganssle's avatar Paul Ganssle Committed by GitHub

Merge pull request #1357 from jmbowman/jmbowman/fix_doc_warnings

Fix doc build warnings
parents c70cc12b 78e887ff
Fixed warnings in documentation builds and started enforcing that the docs build without warnings in tox.
...@@ -34,7 +34,7 @@ import os ...@@ -34,7 +34,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['jaraco.packaging.sphinx', 'rst.linker', 'sphinx.ext.autosectionlabel'] extensions = ['jaraco.packaging.sphinx', 'rst.linker']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
...@@ -45,6 +45,9 @@ source_suffix = '.txt' ...@@ -45,6 +45,9 @@ source_suffix = '.txt'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# A list of glob-style patterns that should be excluded when looking for source files.
exclude_patterns = ['requirements.txt']
# List of directories, relative to source directory, that shouldn't be searched # List of directories, relative to source directory, that shouldn't be searched
# for source files. # for source files.
exclude_trees = [] exclude_trees = []
......
...@@ -1087,6 +1087,7 @@ so that supporting custom importers or new distribution formats can be done ...@@ -1087,6 +1087,7 @@ so that supporting custom importers or new distribution formats can be done
simply by creating an appropriate `IResourceProvider`_ implementation; see the simply by creating an appropriate `IResourceProvider`_ implementation; see the
section below on `Supporting Custom Importers`_ for more details. section below on `Supporting Custom Importers`_ for more details.
.. _ResourceManager API:
``ResourceManager`` API ``ResourceManager`` API
======================= =======================
......
...@@ -242,7 +242,6 @@ have setuptools automatically tag your in-development releases with various ...@@ -242,7 +242,6 @@ have setuptools automatically tag your in-development releases with various
pre- or post-release tags. See the following sections for more details: pre- or post-release tags. See the following sections for more details:
* `Tagging and "Daily Build" or "Snapshot" Releases`_ * `Tagging and "Daily Build" or "Snapshot" Releases`_
* `Managing "Continuous Releases" Using Subversion`_
* The `egg_info`_ command * The `egg_info`_ command
...@@ -1366,6 +1365,7 @@ then make an explicit declaration of ``True`` or ``False`` for the ``zip_safe`` ...@@ -1366,6 +1365,7 @@ then make an explicit declaration of ``True`` or ``False`` for the ``zip_safe``
flag, so that it will not be necessary for ``bdist_egg`` or ``EasyInstall`` to flag, so that it will not be necessary for ``bdist_egg`` or ``EasyInstall`` to
try to guess whether your project can work as a zipfile. try to guess whether your project can work as a zipfile.
.. _Namespace Packages:
Namespace Packages Namespace Packages
------------------ ------------------
......
...@@ -38,8 +38,8 @@ deps = -r{toxinidir}/docs/requirements.txt ...@@ -38,8 +38,8 @@ deps = -r{toxinidir}/docs/requirements.txt
skip_install=True skip_install=True
commands = commands =
python {toxinidir}/bootstrap.py python {toxinidir}/bootstrap.py
sphinx-build -b html -d {envtmpdir}/doctrees docs docs/build/html sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/build/html
sphinx-build -b man -d {envtmpdir}/doctrees docs docs/build/man sphinx-build -W -b man -d {envtmpdir}/doctrees docs docs/build/man
[coverage:run] [coverage:run]
source= source=
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment