IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Consistently name the object description options (#11533)

Browse Source 
*  The directive option ``:noindex:`` was renamed to ``:no-index:``.
*  The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``.
*  The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``.

The previous names are retained as aliases, but will be deprecated
and removed in a future version of Sphinx (9.0 or later).
This commit is contained in:
Adam Turner
2023-07-28 22:30:26 +01:00
committed by GitHub
parent ff20efcd7e
commit 1cfb68d8be
31 changed files with 264 additions and 212 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/development/overview.rst
View File

@@ -12,7 +12,7 @@ project's :file:`conf.py` file, but this is not available to you as an
extension developer.
.. module:: sphinx.application
:noindex:
:no-index:
To ensure that another extension is activated as a part of your own extension,
use the :meth:`sphinx.application.Sphinx.setup_extension` method. This will

2
doc/development/templating.rst
View File

@@ -226,7 +226,7 @@ them to generate links or output multiply used elements.
documents.
.. function:: pathto(file, 1)
:noindex:
:no-index:
Return the path to a *file* which is a filename relative to the root of the
generated output. Use this to refer to static files.