diff options
| author | Paul Ganssle <pganssle@users.noreply.github.com> | 2018-05-15 07:06:40 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-15 07:06:40 -0400 |
| commit | 26b75f5151a761f3206b0dbf68f4e56363ca2ed4 (patch) | |
| tree | 8aa827ff3805813e782505d9c7cc095fa6982c25 | |
| parent | c70cc12b459ceaac1cc9df65b9e3a8582c5c49e4 (diff) | |
| parent | 78e887ff5b3d87f052b7195181eeb1f3d251f760 (diff) | |
| download | python-setuptools-git-26b75f5151a761f3206b0dbf68f4e56363ca2ed4.tar.gz | |
Merge pull request #1357 from jmbowman/jmbowman/fix_doc_warnings
Fix doc build warnings
| -rw-r--r-- | changelog.d/1357.doc.rst | 1 | ||||
| -rw-r--r-- | docs/conf.py | 5 | ||||
| -rw-r--r-- | docs/pkg_resources.txt | 1 | ||||
| -rw-r--r-- | docs/setuptools.txt | 2 | ||||
| -rw-r--r-- | tox.ini | 4 |
5 files changed, 9 insertions, 4 deletions
diff --git a/changelog.d/1357.doc.rst b/changelog.d/1357.doc.rst new file mode 100644 index 00000000..11d97cc7 --- /dev/null +++ b/changelog.d/1357.doc.rst @@ -0,0 +1 @@ +Fixed warnings in documentation builds and started enforcing that the docs build without warnings in tox. diff --git a/docs/conf.py b/docs/conf.py index f7d02303..c7eb6d3f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,7 +34,7 @@ import os # Add any Sphinx extension module names here, as strings. They can be extensions # 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. templates_path = ['_templates'] @@ -45,6 +45,9 @@ source_suffix = '.txt' # The master toctree document. 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 # for source files. exclude_trees = [] diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt index b40a209f..18545f4b 100644 --- a/docs/pkg_resources.txt +++ b/docs/pkg_resources.txt @@ -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 section below on `Supporting Custom Importers`_ for more details. +.. _ResourceManager API: ``ResourceManager`` API ======================= diff --git a/docs/setuptools.txt b/docs/setuptools.txt index e14d2088..5ee967ab 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -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: * `Tagging and "Daily Build" or "Snapshot" Releases`_ -* `Managing "Continuous Releases" Using Subversion`_ * The `egg_info`_ command @@ -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 try to guess whether your project can work as a zipfile. +.. _Namespace Packages: Namespace Packages ------------------ @@ -38,8 +38,8 @@ deps = -r{toxinidir}/docs/requirements.txt skip_install=True commands = python {toxinidir}/bootstrap.py - sphinx-build -b html -d {envtmpdir}/doctrees docs docs/build/html - sphinx-build -b man -d {envtmpdir}/doctrees docs docs/build/man + sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/build/html + sphinx-build -W -b man -d {envtmpdir}/doctrees docs docs/build/man [coverage:run] source= |