Skip to content

Commit 63ff77f

Browse files
committed
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.
1 parent 2724116 commit 63ff77f

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

doc/conf.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -354,9 +354,12 @@ def _check_dependencies():
354354
# '**': ['localtoc.html', 'pagesource.html']
355355
}
356356

357-
# If false, no module index is generated.
358-
# html_use_modindex = True
359-
html_domain_indices = ["py-modindex"]
357+
# If true, add an index to the HTML documents.
358+
html_use_index = False
359+
360+
# If true, generate domain-specific indices in addition to the general index.
361+
# For e.g. the Python domain, this is the global module index.
362+
html_domain_index = False
360363

361364
# If true, the reST sources are included in the HTML build as _sources/<name>.
362365
# html_copy_source = True

doc/contents.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,4 @@ Contents
2222

2323
.. only:: html
2424

25-
* :ref:`genindex`
26-
* :ref:`modindex`
2725
* :ref:`search`

0 commit comments

Comments
 (0)