Skip to content

Commit

Permalink
✏️ Switch Sphinx doc links to intersphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
veit committed Jul 9, 2024
1 parent 49be631 commit 5a42a6b
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 15 deletions.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
intersphinx_mapping = {
"jupyter-tutorial": (f"{jupyter_tutorial_url}", None),
"python-basics": (f"{python_basics_url}", None),
"sphinx": ("https://www.sphinx-doc.org/en/master/", None),
}


Expand Down
21 changes: 8 additions & 13 deletions docs/writing/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,14 @@ sie ist jedoch nicht vollständig.
Sprachunterstützung in Sphinx
-----------------------------

`Sphinx <https://www.sphinx-doc.org/>`_ unterstützt verschiedene Sprachen,
:abbr:`u.a. (unter anderem)`

* `Python
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-python-domain>`_
* `C
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-c-domain>`_
* `C++
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cpp-domain>`_
* `JavaScript
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#the-javascript-domain>`_
* `Math
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#math-domain>`_
:doc:`sphinx:index` unterstützt verschiedene Sprachen, :abbr:`u.a. (unter
anderem)`

* :doc:`Python <sphinx:usage/domains/python>`
* :doc:`C <sphinx:usage/domains/c>`
* :doc:`C++ <sphinx:usage/domains/cpp>`
* :doc:`JavaScript <sphinx:usage/domains/javascript>`
* :doc:`Math <sphinx:usage/domains/mathematics>`
* `MATLAB
<https://pypi.org/project/sphinxcontrib-matlabdomain/>`_
* `Scala
Expand Down
4 changes: 2 additions & 2 deletions docs/writing/writing-style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ verwendet werden. Zudem sollten sie durch das ``abbr``-Tag gekennzeichnet sein,
Bedienung über Tastatureingaben.

.. note::
In unserem Dokumentationssystem `Sphinx <https://www.sphinx-doc.org/en/master/>`_ könnt
ihr diesen Tag mit der ``:abbr:``-Rolle hinzufügen.
In unserem Dokumentationssystem :doc:`sphinx:index` könnt ihr diesen Tag mit
der ``:abbr:``-Rolle hinzufügen.

Links
~~~~~
Expand Down

0 comments on commit 5a42a6b

Please sign in to comment.