Skip to content

Commit

Permalink
[TASK] Remove section on genindex
Browse files Browse the repository at this point in the history
We currently do not support a generated output of this file and in most cases it was not very usefull.
  • Loading branch information
linawolf committed Jan 14, 2024
1 parent eb3b745 commit a322579
Showing 1 changed file with 1 addition and 26 deletions.
27 changes: 1 addition & 26 deletions Documentation/GeneralConventions/FileStructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,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 @@ -188,31 +188,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

0 comments on commit a322579

Please sign in to comment.