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

Move the domains reference up one level

Browse Source
This commit is contained in:
Adam Turner
2023-10-01 17:35:47 +01:00
parent b9c85984d2
commit c0e17eca40
9 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/glossary.rst
View File

@@ -59,7 +59,7 @@ Glossary
means that extensions that support the documentation of whole new means that extensions that support the documentation of whole new
languages are much easier to write. languages are much easier to write.
For more information, refer to :doc:`/usage/restructuredtext/domains`. For more information, refer to :doc:`/usage/domains/index`.
environment environment
A structure where information about all documents under the root is saved, A structure where information about all documents under the root is saved,

2
doc/tutorial/describing-code.rst
View File

@@ -8,7 +8,7 @@ will describe code objects instead.
Sphinx supports documenting code objects in several languages, namely Python, Sphinx supports documenting code objects in several languages, namely Python,
C, C++, JavaScript, and reStructuredText. Each of them can be documented using C, C++, JavaScript, and reStructuredText. Each of them can be documented using
a series of directives and roles grouped by a series of directives and roles grouped by
:doc:`domain </usage/restructuredtext/domains>`. For the remainder of the :doc:`domain </usage/domains/index>`. For the remainder of the
tutorial you will use the Python domain, but all the concepts seen in this tutorial you will use the Python domain, but all the concepts seen in this
section apply for the other domains as well. section apply for the other domains as well.

2
doc/usage/configuration.rst
View File

@@ -292,7 +292,7 @@ General configuration
.. index:: default; domain .. index:: default; domain
primary; domain primary; domain
The name of the default :doc:`domain </usage/restructuredtext/domains>`. The name of the default :doc:`domain </usage/domains/index>`.
Can also be ``None`` to disable a default domain. The default is ``'py'``. Can also be ``None`` to disable a default domain. The default is ``'py'``.
Those objects in other domains (whether the domain name is given explicitly, Those objects in other domains (whether the domain name is given explicitly,
or selected by a :rst:dir:`default-domain` directive) will have the domain or selected by a :rst:dir:`default-domain` directive) will have the domain

0
doc/usage/restructuredtext/domains.rst → doc/usage/domains/index.rst
View File

1
doc/usage/index.rst
View File

@@ -14,6 +14,7 @@ looking for guidance on extending Sphinx, refer to :doc:`/development/index`.
markdown markdown
configuration configuration
builders/index builders/index
domains/index
extensions/index extensions/index
theming theming
advanced/intl advanced/intl

2
doc/usage/quickstart.rst
View File

@@ -220,7 +220,7 @@ Each domain will have special rules for how the signatures can look like, and
make the formatted output look pretty, or add specific features like links to make the formatted output look pretty, or add specific features like links to
parameter types, e.g. in the C/C++ domains. parameter types, e.g. in the C/C++ domains.
|more| See :doc:`/usage/restructuredtext/domains` for all the available domains |more| See :doc:`/usage/domains/index` for all the available domains
and their directives/roles. and their directives/roles.

4
doc/usage/restructuredtext/directives.rst
View File

@@ -9,7 +9,7 @@ of explicit markup. While Docutils provides a number of directives, Sphinx
provides many more and uses directives as one of the primary extension provides many more and uses directives as one of the primary extension
mechanisms. mechanisms.
See :doc:`/usage/restructuredtext/domains` for roles added by domains. See :doc:`/usage/domains/index` for roles added by domains.
.. seealso:: .. seealso::
@@ -881,7 +881,7 @@ Index-generating markup
Sphinx automatically creates index entries from all object descriptions (like Sphinx automatically creates index entries from all object descriptions (like
functions, classes or attributes) like discussed in functions, classes or attributes) like discussed in
:doc:`/usage/restructuredtext/domains`. :doc:`/usage/domains/index`.
However, there is also explicit markup available, to make the index more However, there is also explicit markup available, to make the index more
comprehensive and enable index entries in documents where information is not comprehensive and enable index entries in documents where information is not

1
doc/usage/restructuredtext/index.rst
View File

@@ -21,4 +21,3 @@ __ https://docutils.sourceforge.io/rst.html
roles roles
directives directives
field-lists field-lists
domains

2
doc/usage/restructuredtext/roles.rst
View File

@@ -15,7 +15,7 @@ They are written as ``:rolename:`content```.
:rst:role:`any` role to find anything or the :rst:role:`py:obj` role to find :rst:role:`any` role to find anything or the :rst:role:`py:obj` role to find
Python objects are very useful for this. Python objects are very useful for this.
See :doc:`/usage/restructuredtext/domains` for roles added by domains. See :doc:`/usage/domains/index` for roles added by domains.
.. _xref-syntax: .. _xref-syntax: