elastic-recheck/doc/source/index.rst
Matt Riedemann 9f44f79a2d Fix the module index link in the docs
Since we weren't autodoc'ing the modules during the docs build, the
module index link was broken.

This generates the module docs (but hides them from the main top-level
table of contents) so they can be accessed via the 'Module Index' link.

Also cleans up some docs issues so that warnerrors=True works during
sphinx-build.

Closes-Bug: #1472642

Change-Id: I5a3a16d1e81b12237452d5a3a3f7f0cc42618e88
2015-07-08 07:54:23 -07:00

33 lines
739 B
ReStructuredText

.. elastic-recheck documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to elastic-recheck's documentation!
========================================================
Contents:
.. toctree::
:maxdepth: 2
readme
installation
usage
contributing
.. # NOTE(mriedem): This is where we hide things that we don't want shown in
# the top level table of contents. api/autoindex is hidden since it's in
# the modindex link below.
.. toctree::
:hidden:
api/autoindex
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`