Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit abc3106

Browse filesBrowse files
committed
tox: Enable nitpicky mode for docs builds
Signed-off-by: Stephen Finucane <stephen@that.guru> Closes: #103
1 parent 27df09a commit abc3106
Copy full SHA for abc3106

File tree

3 files changed

+13
-13
lines changed
Filter options

3 files changed

+13
-13
lines changed

‎docs/conf.py

Copy file name to clipboardExpand all lines: docs/conf.py
+5-4Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
#
33
# sphinx-click documentation build configuration file
44

5-
# import os
6-
# import sys
7-
# sys.path.insert(0, os.path.abspath('.'))
5+
import os
6+
import sys
7+
8+
sys.path.insert(0, os.path.abspath('../examples'))
89

910
# -- General configuration ------------------------------------------------
1011

@@ -15,7 +16,7 @@
1516
# Add any Sphinx extension module names here, as strings. They can be
1617
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
1718
# ones.
18-
extensions = ["sphinx_click"]
19+
extensions = ['sphinx_click']
1920

2021
# Add any paths that contain templates here, relative to this directory.
2122
templates_path = []

‎docs/index.rst

Copy file name to clipboardExpand all lines: docs/index.rst
+7-7Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
sphinx-click
22
============
33

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

88
__ http://www.sphinx-doc.org/
99
__ http://click.pocoo.org/
@@ -19,9 +19,9 @@ __ http://click.pocoo.org/
1919

2020
.. seealso::
2121

22-
Module :mod:`click`
23-
This extension assumes you are using :mod:`click` to create your command
22+
Module ``click``
23+
This extension assumes you are using ``click`` to create your command
2424
line application.
2525

26-
Module :mod:`sphinxcontrib.autoprogram`
27-
An equivalent library for use with :mod:`argparse`.
26+
Module ``sphinxcontrib.autoprogram``
27+
An equivalent library for use with ``argparse``.

‎tox.ini

Copy file name to clipboardExpand all lines: tox.ini
+1-2Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ commands =
3333

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

3938
[coverage:run]
4039
branch = True

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.