From 1502825ef0055ba05f8ee2dd161aa1edd09ac662 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Thu, 16 Sep 2021 23:24:53 +0200 Subject: [PATCH] Remove the index and module index pages The index is not really helpful. Search is better for all practical purposes. The module index is redundant to the module list on the reference page. And the latter is better because we can control what to show; e.g. we leave out the specific backend modules. --- doc/conf.py | 9 ++++++--- doc/contents.rst | 2 -- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 77b879d6f371..8c010bd71cba 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -354,9 +354,12 @@ def _check_dependencies(): # '**': ['localtoc.html', 'pagesource.html'] } -# If false, no module index is generated. -# html_use_modindex = True -html_domain_indices = ["py-modindex"] +# If true, add an index to the HTML documents. +html_use_index = False + +# If true, generate domain-specific indices in addition to the general index. +# For e.g. the Python domain, this is the global module index. +html_domain_index = False # If true, the reST sources are included in the HTML build as _sources/. # html_copy_source = True diff --git a/doc/contents.rst b/doc/contents.rst index f9d10936c7fc..4f070951d9e7 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -22,6 +22,4 @@ Contents .. only:: html - * :ref:`genindex` - * :ref:`modindex` * :ref:`search`