Skip to content

Commit

Permalink
tox: Enable nitpicky mode for docs builds
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #103
  • Loading branch information
stephenfin committed Apr 26, 2022
1 parent 27df09a commit abc3106
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
9 changes: 5 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
#
# sphinx-click documentation build configuration file

# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys

sys.path.insert(0, os.path.abspath('../examples'))

# -- General configuration ------------------------------------------------

Expand All @@ -15,7 +16,7 @@
# 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_click"]
extensions = ['sphinx_click']

# Add any paths that contain templates here, relative to this directory.
templates_path = []
Expand Down
14 changes: 7 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
sphinx-click
============

:mod:`sphinx-click <sphinx_click>` is a `Sphinx`__ plugin that allows you to
automatically extract documentation from a `click-based`__ application and
include it in your docs.
``sphinx-click`` is a `Sphinx`__ plugin that allows you to automatically
extract documentation from a `click-based`__ application and include it in
your docs.

__ http://www.sphinx-doc.org/
__ http://click.pocoo.org/
Expand All @@ -19,9 +19,9 @@ __ http://click.pocoo.org/

.. seealso::

Module :mod:`click`
This extension assumes you are using :mod:`click` to create your command
Module ``click``
This extension assumes you are using ``click`` to create your command
line application.

Module :mod:`sphinxcontrib.autoprogram`
An equivalent library for use with :mod:`argparse`.
Module ``sphinxcontrib.autoprogram``
An equivalent library for use with ``argparse``.
3 changes: 1 addition & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ commands =

[testenv:docs]
commands =
pip install -e {toxinidir}/examples/
sphinx-build -W -b html -d docs/_build/doctrees docs docs/_build/html
sphinx-build -Wn -b html -d docs/_build/doctrees docs docs/_build/html

[coverage:run]
branch = True

0 comments on commit abc3106

Please sign in to comment.