From 6cff4b2cb70ba41d6b90a39c829043efa195eec9 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Tue, 31 Jul 2018 07:48:46 -0700 Subject: 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 --- docs/Makefile | 2 +- docs/index.rst | 7 ++----- tasks.py | 3 ++- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 76bdbe20..433ddd3c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -nvWT SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build diff --git a/docs/index.rst b/docs/index.rst index d3b2adfe..31bb4771 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -75,10 +75,7 @@ Compatibility Tested and working with Python 3.4+ on Windows, macOS, and Linux. -Indices and tables -================== +Index +===== * :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/tasks.py b/tasks.py index 183a033d..583674e9 100644 --- a/tasks.py +++ b/tasks.py @@ -89,11 +89,12 @@ namespace_clean.add_task(tox_clean, 'tox') ##### DOCS_SRCDIR = 'docs' DOCS_BUILDDIR = os.path.join('docs', '_build') +SPHINX_OPTS = '-nvWT' # Be nitpicky, verbose, and treat warnings as errors @invoke.task() def docs(context, builder='html'): "Build documentation using sphinx" - cmdline = 'python -msphinx -M {} {} {}'.format(builder, DOCS_SRCDIR, DOCS_BUILDDIR) + cmdline = 'python -msphinx -M {} {} {} {}'.format(builder, DOCS_SRCDIR, DOCS_BUILDDIR, SPHINX_OPTS) context.run(cmdline) namespace.add_task(docs) -- cgit v1.2.1