Skip to content

Commit 6cff4b2

Browse files
committed
Removed non-working Module Index link from the main Sphinx docs page
Also: * Improved Sphinx build options in Makefile and via invoke by adding the following options: * -n : nit-picky mode, warn about all missing references * -v : increase verbosity (can be repeated) * -W : turn warnings into errors * -T : show full traceback on exception
1 parent bc559df commit 6cff4b2

File tree

3 files changed

+5
-7
lines changed

3 files changed

+5
-7
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33

44
# You can set these variables from the command line.
5-
SPHINXOPTS =
5+
SPHINXOPTS = -nvWT
66
SPHINXBUILD = sphinx-build
77
PAPER =
88
BUILDDIR = _build

docs/index.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,7 @@ Compatibility
7575

7676
Tested and working with Python 3.4+ on Windows, macOS, and Linux.
7777

78-
Indices and tables
79-
==================
78+
Index
79+
=====
8080

8181
* :ref:`genindex`
82-
* :ref:`modindex`
83-
* :ref:`search`
84-

tasks.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,12 @@ def tox_clean(context):
8989
#####
9090
DOCS_SRCDIR = 'docs'
9191
DOCS_BUILDDIR = os.path.join('docs', '_build')
92+
SPHINX_OPTS = '-nvWT' # Be nitpicky, verbose, and treat warnings as errors
9293

9394
@invoke.task()
9495
def docs(context, builder='html'):
9596
"Build documentation using sphinx"
96-
cmdline = 'python -msphinx -M {} {} {}'.format(builder, DOCS_SRCDIR, DOCS_BUILDDIR)
97+
cmdline = 'python -msphinx -M {} {} {} {}'.format(builder, DOCS_SRCDIR, DOCS_BUILDDIR, SPHINX_OPTS)
9798
context.run(cmdline)
9899
namespace.add_task(docs)
99100

0 commit comments

Comments
 (0)