diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-07-31 07:48:46 -0700 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2018-07-31 07:48:46 -0700 |
| commit | 6cff4b2cb70ba41d6b90a39c829043efa195eec9 (patch) | |
| tree | aaf8658dd9ac63e2ba79046285016b969059386a /docs | |
| parent | bc559df2afcc51d1804e5d068d7e2c57bc4f72af (diff) | |
| download | cmd2-git-6cff4b2cb70ba41d6b90a39c829043efa195eec9.tar.gz | |
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
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/index.rst | 7 |
2 files changed, 3 insertions, 6 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` - |