Skip to content

Commit

Permalink
[TASK] Bugfix: do not use interlinks to the own repository
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Jul 28, 2024
1 parent 8e506f5 commit c0ef22d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions Documentation/Howto/Migration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ file :file:`genindex.rst` in your :file:`Documentation/` directory (if available

While you could already jump in and render your documentation directly
(see :ref:`local rendering <rendering-docs>`), we suggest to clean up the following other
things first (:ref:`see <h2document:migrate-detailed-steps>`).
things first (:ref:`see <migrate-detailed-steps>`).


.. _migrate-detailed-steps:
Expand Down Expand Up @@ -190,7 +190,7 @@ Use our Docker container to render your documentation locally. Read more about i
The following list is not a requirement to utilize the PHP-based rendering, but
follows "best practice" to make the most of your documentation project.
One of the biggest benefits is, that this simplifies finding
:ref:`errors <h2document:migrate-possible-errors>` in your reST syntax.
:ref:`errors <migrate-possible-errors>` in your reST syntax.
The :file:`Makefile` helps you to launch the local rendering described in :ref:`here <rendering-docs>`.
You create the :file:`Makefile` in order to register the command shortcuts that you
would use to :ref:`render your documentation locally <rendering-docs>` and also provide an entry point for further shortcuts (like testing).
Expand Down Expand Up @@ -259,15 +259,15 @@ Inventory link with key ... not found

.. code-block:: text
[2024-03-13T12:26:40.940930+00:00] app.WARNING: Inventory link with key "h2document:rest-common-pitfalls"
[2024-03-13T12:26:40.940930+00:00] app.WARNING: Inventory link with key "rest-common-pitfalls"
(rest-common-pitfalls) not found. {"rst-file":"GeneratedExtension/Index","type":"ref","targetRef
We see already that we have to go to file :file:`GeneratedExtension/Index` in the directory "Documentation".
In there we have to delete the line which contains

.. code-block:: text
* :ref:`h2document:rest-common-pitfalls`
* :ref:`rest-common-pitfalls`
But whether we should delete the reference or not depends on the special case. In this case the whole section was removed.
So here it is useful to delete the reference.
Expand Down
6 changes: 3 additions & 3 deletions Documentation/Howto/WritingReST/CheatSheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
.. ------------------------------------------------------------------------
header label: You can use this to create
cross-references: To link to the next section, use :ref:`rest-cheat-sheet`
or :ref:`h2document:rest-cheat-sheet` from another manual
or :ref:`rest-cheat-sheet` from another manual
-------------------------------------------------------------------------
Expand Down Expand Up @@ -126,7 +126,7 @@ Or, when cross-referencing to other manuals:
:ref:`shortcut:label`
:ref:`h2document:intersphinx`
:ref:`intersphinx`


When you are linking to another manual, make sure the
Expand Down Expand Up @@ -609,7 +609,7 @@ Source:
text with a green box (as styled by our sphinx template).
---------------------------------------------------------------
Visit :ref:`h2document:rest-admonitions` to see the available admonitions.
Visit :ref:`rest-admonitions` to see the available admonitions.

**How it looks:**

Expand Down
10 changes: 5 additions & 5 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ reStructuredText (reST).

Go tho the cheat sheet containing a quick overview on how to use reStructuredText.

.. card-footer:: :ref:`Go to the reST Cheat sheet <h2document:rest-cheat-sheet>`
.. card-footer:: :ref:`Go to the reST Cheat sheet <rest-cheat-sheet>`
:button-style: btn btn-secondary stretched-link

.. card:: Edit on GitHub
Expand All @@ -59,7 +59,7 @@ reStructuredText (reST).
you are reading by applying the "Edit on GitHub" workflow. All you
need is a GitHub account.

.. card-footer:: :ref:`How to make quick fixes <h2document:docs-contribute-github-method>`
.. card-footer:: :ref:`How to make quick fixes <docs-contribute-github-method>`
:button-style: btn btn-secondary stretched-link

.. card:: Local rendering
Expand All @@ -69,21 +69,21 @@ reStructuredText (reST).
your changes in and it also gives you the ability to experiment and
preview your changes locally before submitting them for approval.

.. card-footer:: :ref:`How to work locally with documentation <h2document:docs-contribute-git-docker>`
.. card-footer:: :ref:`How to work locally with documentation <docs-contribute-git-docker>`
:button-style: btn btn-secondary stretched-link

.. card:: Extension documentation

This chapter explains how to write documentation for a new extension.

.. card-footer:: :ref:`How to document an extension <h2document:write-doc-extensions-intro>`
.. card-footer:: :ref:`How to document an extension <write-doc-extensions-intro>`
:button-style: btn btn-secondary stretched-link

.. card:: System Extensions

The chapter contains information on how you can make changes to system extension documentation.

.. card-footer:: :ref:`How to document system extensions <h2document:contribute-to-system-extension>`
.. card-footer:: :ref:`How to document system extensions <contribute-to-system-extension>`
:button-style: btn btn-secondary stretched-link

.. toctree::
Expand Down

0 comments on commit c0ef22d

Please sign in to comment.