diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-08-05 15:42:31 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-08-05 15:42:31 -0400 |
| commit | ab6da6182c6055108179eb762208b13115365b88 (patch) | |
| tree | 855899a28ea0d8cb351a01cf30b3c5873dff745b | |
| parent | 94a7c993f1d251d066f15439c08992871325813d (diff) | |
| parent | b7e265e547a85adc080f6778eb80b57ff4bad2b6 (diff) | |
| download | cmd2-git-ab6da6182c6055108179eb762208b13115365b88.tar.gz | |
Merge pull request #491 from python-cmd2/module_index
Removed non-working Module Index link from the main Sphinx docs page
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/index.rst | 7 | ||||
| -rw-r--r-- | 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` - @@ -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) |