Merge branch 'docs-refs' into 'master'

[Docs] Add references

See merge request !110

docs/admin/10_features.rst

@@ -7,7 +7,7 @@ functionality to automatically import data from Untis into data models
 of the core and `Chronos`, the timetable and substitution app of AlekSIS.
 
 Currently, we only support importing data from the MySQL database of
-`Untis MultiUser`. This is done through configurable background tasks
+`Untis MultiUser`_. This is done through configurable background tasks
 which are executed in a specific interval or at specific points in time.
 
 Supported Untis features
@@ -34,3 +34,5 @@ Currently, the following features are known not to be supported:
 * Prebookings
 * Statistical data
 * Special rooms (subject and group rooms)
+
+.. _Untis MultiUser: https://www.untis.at/produkte/untis-das-grundpaket/multiuser

docs/admin/20_configuration.rst

@@ -9,14 +9,14 @@ license (version 2019 and above) and a MySQL database which
 is reachable by the AlekSIS server. How to configure Untis
 to use this database is described in the `Untis MultiUser Manual`_.
 
-In addition to the technical requirements of AlekSIS itself,
-a few extra system packages are required:
+In addition to the technical :ref:`core-install-prerequisites` of
+the AlekSIS core itself, a few extra system packages are required:
 
 .. code-block:: shell
 
    apt install libmariadb-dev
 
-The MySQL (or MariaDB) server must be reachable from the AlekSIS
+The MySQL (or `MariaDB`_) server must be reachable from the AlekSIS
 server, and a user account in the database is needed. It is sufficient
 to create this user with ``SELECT`` permissions. On the MySQL shell,
 you can create such a user with something like:
@@ -32,7 +32,8 @@ you can create such a user with something like:
 Configure database connection
 -----------------------------
 
-In the AlekSIS configuration file, you have to set following settings:
+In the AlekSIS configuration file (cf. :ref:`core-configuration-files`),
+you have to set the following settings:
 
 .. code-block:: toml
 
@@ -72,7 +73,7 @@ The way data are imported can be configured from the menu under
 Scheduling import tasks
 -----------------------
 
-The integration provides different background tasks to import the data from Untis:
+The integration provides different :ref:`core-periodic-tasks` to import the data from Untis:
 
 * ``untis_import_mysql_current_term``: This will import all data from the **current**
   Untis term.
@@ -98,8 +99,10 @@ How existing data is matched
 
 If there are already existing data in AlekSIS' database, the Untis import will
 always try to combine these data. The main data field used for this is the
-``short name`` field. If the data were imported one time, each object in
-Chronos will save the respective ID from Untis to make sure that the data are
-properly updated at the next import.
+``short name`` field (cf. :ref:`core-concept-group`). If the data were imported
+one time, each object in Chronos will save the respective ID from Untis to make
+sure that the data are properly updated at the next import.
 
 The import is thus idempotent.
+
+.. _MariaDB: https://mariadb.org

docs/conf.py

@@ -204,4 +204,6 @@ epub_exclude_files = ["search.html"]
 intersphinx_mapping = {
     "https://docs.python.org/": None,
     "https://docs.djangoproject.com/en/stable": "https://docs.djangoproject.com/en/stable/_objects",
+    "https://aleksis.edugit.io/AlekSIS-Core/docs": None,
+    "https://aleksis.edugit.io/AlekSIS-App-Chronos/docs": None,
 }