Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-10-12 18:40:57 -04:00
Code Issues Projects Releases Packages Wiki Activity

add labeling of sections inside rst docs

Browse source
This commit is contained in:
qubedmaiska 2025-09-13 11:16:12 -04:00
parent 0f77371239
commit d9a6e20f3a
No known key found for this signature in database
GPG key ID: 204BCE0FD52C0501
1 changed files with 24 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

27
developer/general/rst-documentation-style-guide.rst
View file

@ -295,18 +295,37 @@ Please continue using the above or new ones where appropriate.
Cross referencing:
^^^^^^^^^^^^^^^^^^
Use the `:doc:` role with a path
- Use the `:doc:` role with a path and a custom link text:
.. code:: rst
:doc:`contributions </introduction/contributing>`.
use `:ref:` for specific sections
- Use the `:doc:` role with a path:
.. code:: rst
:ref:`qubes <user/reference/glossary:qube>`
:doc:`/introduction/intro`
- Use `:ref:` for specific sections and a custom link text
.. code:: rst
:ref:`What is Qubes OS? <introduction/intro:what is qubes os?>`
- Use `:ref` only with a unique label above the specific section:
.. code:: rst
.. _cross_referencing:
TL;DR: Cross-referencing
------------------------
and link to the section from within the documentation using :code:`:ref:`cross_referencing``.
For further information please see :ref:`cross_referencing`.