mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Move the domains reference up one level
This commit is contained in:
parent
b9c85984d2
commit
c0e17eca40
@ -59,7 +59,7 @@ Glossary
|
||||
means that extensions that support the documentation of whole new
|
||||
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
|
||||
A structure where information about all documents under the root is saved,
|
||||
|
@ -8,7 +8,7 @@ will describe code objects instead.
|
||||
Sphinx supports documenting code objects in several languages, namely Python,
|
||||
C, C++, JavaScript, and reStructuredText. Each of them can be documented using
|
||||
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
|
||||
section apply for the other domains as well.
|
||||
|
||||
|
@ -292,7 +292,7 @@ General configuration
|
||||
.. index:: default; 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'``.
|
||||
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
|
||||
|
@ -14,6 +14,7 @@ looking for guidance on extending Sphinx, refer to :doc:`/development/index`.
|
||||
markdown
|
||||
configuration
|
||||
builders/index
|
||||
domains/index
|
||||
extensions/index
|
||||
theming
|
||||
advanced/intl
|
||||
|
@ -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
|
||||
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.
|
||||
|
||||
|
||||
|
@ -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
|
||||
mechanisms.
|
||||
|
||||
See :doc:`/usage/restructuredtext/domains` for roles added by domains.
|
||||
See :doc:`/usage/domains/index` for roles added by domains.
|
||||
|
||||
.. seealso::
|
||||
|
||||
@ -881,7 +881,7 @@ Index-generating markup
|
||||
|
||||
Sphinx automatically creates index entries from all object descriptions (like
|
||||
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
|
||||
comprehensive and enable index entries in documents where information is not
|
||||
|
@ -21,4 +21,3 @@ __ https://docutils.sourceforge.io/rst.html
|
||||
roles
|
||||
directives
|
||||
field-lists
|
||||
domains
|
||||
|
@ -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
|
||||
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:
|
||||
|
Loading…
Reference in New Issue
Block a user