Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Remove genindex #375

Merged
merged 2 commits into from
Jan 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 1 addition & 26 deletions Documentation/GeneralConventions/FileStructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ Optional: :file:`Documentation/Sitemap.rst`
-------------------------------------------

The :file:`Sitemap.rst` contains the sitemap of the documentation.
It is an almost empty file that is automatically filled by the Sphinx template.
It is an almost empty file that is automatically filled during rendering.

.. code-block:: rst

Expand All @@ -193,31 +193,6 @@ It is an almost empty file that is automatically filled by the Sphinx template.
.. The sitemap.html template will insert here the page tree automatically.


.. index:: File structure; Documentation/genindex.rst, genindex.rst
.. _genindex-rst:

Optional: Automatic index: :file:`Documentation/genindex.rst`
-------------------------------------------------------------

The genindex.rst shows a list of all indexes of the documentation pages. It is
an almost empty file that is automatically filled by Sphinx. An index can be
manually applied to each documentation location using the
:rst:dir:`index directive <sphinx:index>`.
In addition, some content elements automatically generate indexes, such as the
:ref:`configuration values <rest-confval>` and
:ref:`PHP domain <rest-phpdomain>` elements.

.. code-block:: rst

.. include:: /Includes.rst.txt

=====
Index
=====

.. Sphinx will insert here the general index automatically.


.. index:: File structure; Documentation/Settings.cfg, Settings.cfg
.. _settings-cfg:

Expand Down
1 change: 0 additions & 1 deletion Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,3 @@ What's new in this guide?
:hidden:

Sitemap
genindex
7 changes: 0 additions & 7 deletions Documentation/genindex.rst

This file was deleted.