Doc references are now absolute dsmrreader#1315

.gitignore

@@ -11,6 +11,7 @@
 /dsmrreader/settings.py.BACKUP
 /docs/_locale/nl/LC_MESSAGES/**/changelog.po
 /docs/_locale/nl/LC_MESSAGES/**/changelog.mo
+/docs/_locale/nl/LC_MESSAGES/how-to/upgrading/to-
 /coverage_report/
 /backups/
 /logs/

docs/_locale/nl/LC_MESSAGES/how-to/admin/set-username-password.po

@@ -44,13 +44,13 @@ msgid "Docker installation"
 msgstr "Docker-installatie"
 
 #: ../../how-to/admin/set-username-password.rst:30
-msgid "The ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` :doc:`as defined in Env Settings<../../reference/env-settings>` will be used for the credentials."
-msgstr "De ``DSMRREADER_ADMIN_USER`` en ``DSMRREADER_ADMIN_PASSWORD`` :doc:`zoals gespecificeerd in Env-instellingen<../../reference/env-settings>` worden gebruikt als inloggegevens."
+msgid "The ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` :doc:`as defined in Env Settings</reference/env-settings>` will be used for the credentials."
+msgstr "De ``DSMRREADER_ADMIN_USER`` en ``DSMRREADER_ADMIN_PASSWORD`` :doc:`zoals gespecificeerd in Env-instellingen</reference/env-settings>` worden gebruikt als inloggegevens."
 
 #: ../../how-to/admin/set-username-password.rst:32
 msgid "Creating or updating credentials:"
 msgstr "Inloggegevens aanmaken of bijwerken:"
 
 #: ../../how-to/admin/set-username-password.rst:34
-msgid "Configure ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` of the :doc:`Env Settings<../../reference/env-settings>`."
-msgstr "Configureer ``DSMRREADER_ADMIN_USER`` en ``DSMRREADER_ADMIN_PASSWORD`` van de :doc:`Environment-instellingen<../../reference/env-settings>`."
+msgid "Configure ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` of the :doc:`Env Settings</reference/env-settings>`."
+msgstr "Configureer ``DSMRREADER_ADMIN_USER`` en ``DSMRREADER_ADMIN_PASSWORD`` van de :doc:`Environment-instellingen</reference/env-settings>`."

docs/_locale/nl/LC_MESSAGES/how-to/installation/quick.po

@@ -71,5 +71,5 @@ msgid "DSMR-reader"
 msgstr "DSMR-reader"
 
 #: ../../how-to/installation/quick.rst:111
-msgid ":doc:`Finished? Go to setting up the application<../../tutorial/setting-up>`."
-msgstr ":doc:`Klaar? Ga dan naar applicatie instellen<../../tutorial/setting-up>`."
+msgid ":doc:`Finished? Go to setting up the application</tutorial/setting-up>`."
+msgstr ":doc:`Klaar? Ga dan naar applicatie instellen</tutorial/setting-up>`."

docs/_locale/nl/LC_MESSAGES/how-to/installation/remote-datalogger.po

@@ -47,12 +47,12 @@ msgid "Receiving DSMR-reader instance"
 msgstr "Ontvangende DSMR-reader-instantie"
 
 #: ../../how-to/installation/remote-datalogger.rst:24
-msgid "Make sure to first prepare the API at the DSMR-reader instance you'll forward the telegrams to. You can enable the API and view/edit the API key used :doc:`in the configuration<../../tutorial/configuration>`."
-msgstr "Zorg ervoor dat je eerste de API van de ontvangende DSMR-reader-instantie klaar hebt staan. Je kunt daar de API inschakelen en bijbehorende API-sleutel inzien/bewerken :doc:`in de configuratie<../../tutorial/configuration>`."
+msgid "Make sure to first prepare the API at the DSMR-reader instance you'll forward the telegrams to. You can enable the API and view/edit the API key used :doc:`in the configuration</tutorial/configuration>`."
+msgstr "Zorg ervoor dat je eerste de API van de ontvangende DSMR-reader-instantie klaar hebt staan. Je kunt daar de API inschakelen en bijbehorende API-sleutel inzien/bewerken :doc:`in de configuratie</tutorial/configuration>`."
 
 #: ../../how-to/installation/remote-datalogger.rst:29
-msgid "If your smart meter only supports DSMR v2 (or you are using a non Dutch smart meter), make sure to change the DSMR version :doc:`in the configuration<../../tutorial/configuration>` as well, to have DSMR-reader parse them correctly."
-msgstr "Wanneer je slimme meter alleen DSMR v2 ondersteunt (of je gebruikt een niet-Nederlandse slimme meter), zorg er dan voor dat je de DSMR-versie aanpast :doc:`in de datalogger-configuratie <../../tutorial/configuration>`, zodat DSMR-reader de telegrammen goed kan verwerken."
+msgid "If your smart meter only supports DSMR v2 (or you are using a non Dutch smart meter), make sure to change the DSMR version :doc:`in the configuration</tutorial/configuration>` as well, to have DSMR-reader parse them correctly."
+msgstr "Wanneer je slimme meter alleen DSMR v2 ondersteunt (of je gebruikt een niet-Nederlandse slimme meter), zorg er dan voor dat je de DSMR-versie aanpast :doc:`in de datalogger-configuratie </tutorial/configuration>`, zodat DSMR-reader de telegrammen goed kan verwerken."
 
 #: ../../how-to/installation/remote-datalogger.rst:31
 msgid "Also, you should disable the datalogger process over there, since you won't be using it anyway::"

docs/_locale/nl/LC_MESSAGES/how-to/third-party/docker.po

@@ -47,5 +47,5 @@ msgid "https://hub.docker.com/r/xirixiz/dsmr-reader-docker/"
 msgstr "https://hub.docker.com/r/xirixiz/dsmr-reader-docker/"
 
 #: ../../how-to/third-party/docker.rst:15
-msgid ":doc:`Finished? Go to setting up the application<../../tutorial/setting-up>`."
-msgstr ":doc:`Klaar? Ga dan naar applicatie instellen<../../tutorial/setting-up>`."
+msgid ":doc:`Finished? Go to setting up the application</tutorial/setting-up>`."
+msgstr ":doc:`Klaar? Ga dan naar applicatie instellen</tutorial/setting-up>`."

docs/_locale/nl/LC_MESSAGES/reference/api.po

@@ -66,14 +66,14 @@ msgid "Enable API"
 msgstr "API inschakelen"
 
 #: ../../reference/api.rst:47
-msgid "The API is disabled by default in the application. You may enable it :doc:`in the configuration<../tutorial/configuration>`."
-msgstr "De API is standaard uitgeschakeld. Je kunt deze :doc:`in de configuratie<../tutorial/configuration>` inschakelen."
+msgid "The API is disabled by default in the application. You may enable it :doc:`in the configuration</tutorial/configuration>`."
+msgstr "De API is standaard uitgeschakeld. Je kunt deze :doc:`in de configuratie</tutorial/configuration>` inschakelen."
 
 #: ../../reference/api.rst:54
 msgid "API key"
 msgstr "API-sleutel"
 
 #: ../../reference/api.rst:56
-msgid "A random API key is generated for you by default. You can always view or update it :doc:`in the configuration<../tutorial/configuration>`."
-msgstr "Standaard wordt een willekeurige API-sleutel voor je gegenereerd. Je kunt deze altijd bekijken of bijwerken :doc:`in de configuratie<../tutorial/configuration>`."
+msgid "A random API key is generated for you by default. You can always view or update it :doc:`in the configuration</tutorial/configuration>`."
+msgstr "Standaard wordt een willekeurige API-sleutel voor je gegenereerd. Je kunt deze altijd bekijken of bijwerken :doc:`in de configuratie</tutorial/configuration>`."
 

docs/_locale/nl/LC_MESSAGES/reference/faq.po

@@ -545,8 +545,8 @@ msgid "Sometimes, when relocating or due to replacement of your meter, the meter
 msgstr "Het komt soms voor dat, door verhuizing of technische vervanging van je meter, deze meterstanden in DSMR-reader voor afwijkingen en onjuiste gegevens zorgen (bijv.: grote gaten of negatief verbruik). Dit komt alleen voor bij de dag zelf en niet bij de dagen erna. Daarom zul je de gegevens van de foutieve dag zelf moeten aanpassen."
 
 #: ../../reference/faq.rst:510
-msgid "The day after, you should be able to manually adjust any invalid Day or Hour Statistics :doc:`in the admin interface<../tutorial/configuration>` for the invalid day."
-msgstr "De dag erna kun je dit zelf weer rechtzetten via de Dag- of Uurtotalen, :doc:`in de admin-configuratie<../tutorial/configuration>`, voor de betreffende dag."
+msgid "The day after, you should be able to manually adjust any invalid Day or Hour Statistics :doc:`in the admin interface</tutorial/configuration>` for the invalid day."
+msgstr "De dag erna kun je dit zelf weer rechtzetten via de Dag- of Uurtotalen, :doc:`in de admin-configuratie</tutorial/configuration>`, voor de betreffende dag."
 
 #: ../../reference/faq.rst:514
 msgid "How do I fix my smart meter reporting invalid dates?"
@@ -593,16 +593,16 @@ msgid "How can I increase the datalogger sleep time?"
 msgstr "Hoe verhoog ik de slaaptijd van de datalogger?"
 
 #: ../../reference/faq.rst:551
-msgid "Increase the datalogger sleep time :doc:`in the configuration<../tutorial/configuration>` to 5 seconds or higher. This will save a lot of disk storage, especially when using a Raspberry Pi SD card, usually having a size of 16 GB max."
-msgstr "Verhoog de slaaptijd van de datalogger :doc:`binnen de configuratie<../tutorial/configuration>` naar minimaal 5 seconden. Dit bespaart een hoop schijfruimte, met name wanneer je een standaard Raspberry Pi SD-kaart gebruikt, die meestal maximaal 16 GB groot zijn."
+msgid "Increase the datalogger sleep time :doc:`in the configuration</tutorial/configuration>` to 5 seconds or higher. This will save a lot of disk storage, especially when using a Raspberry Pi SD card, usually having a size of 16 GB max."
+msgstr "Verhoog de slaaptijd van de datalogger :doc:`binnen de configuratie</tutorial/configuration>` naar minimaal 5 seconden. Dit bespaart een hoop schijfruimte, met name wanneer je een standaard Raspberry Pi SD-kaart gebruikt, die meestal maximaal 16 GB groot zijn."
 
 #: ../../reference/faq.rst:556
 msgid "How can I configure a data retention policy?"
 msgstr "Hoe stel ik een gegevensretentiebeleid in?"
 
 #: ../../reference/faq.rst:558
-msgid "Configure a data retention policy :doc:`in the configuration<../tutorial/configuration>`. This will eventually delete up to 99 percent of the telegrams, always preserving a few historically. Also, day and hour totals are **never** deleted by retention policies."
-msgstr " Stel een gegevensretentiebeleid in :doc:`binnen de configuratie<../tutorial/configuration>`. Dit schoont uiteindelijk tot 99 procent van de telegrammen op, waarbij een aantal altijd achterblijven i.v.m. historie. Daarnaast worden uur- en dagtotalen **nooit** opgeschoond door het retentiebeleid."
+msgid "Configure a data retention policy :doc:`in the configuration</tutorial/configuration>`. This will eventually delete up to 99 percent of the telegrams, always preserving a few historically. Also, day and hour totals are **never** deleted by retention policies."
+msgstr " Stel een gegevensretentiebeleid in :doc:`binnen de configuratie</tutorial/configuration>`. Dit schoont uiteindelijk tot 99 procent van de telegrammen op, waarbij een aantal altijd achterblijven i.v.m. historie. Daarnaast worden uur- en dagtotalen **nooit** opgeschoond door het retentiebeleid."
 
 #: ../../reference/faq.rst:569
 msgid "I'm missing gas readings?"
@@ -617,8 +617,8 @@ msgid "How do I only use the datalogger?"
 msgstr "Hoe gebruik ik alleen de datalogger?"
 
 #: ../../reference/faq.rst:581
-msgid ":doc:`More information can be found here <../how-to/installation/remote-datalogger>`."
-msgstr ":doc:`Meer informatie kun je hier terugvinden<../how-to/installation/remote-datalogger>`."
+msgid ":doc:`More information can be found here </how-to/installation/remote-datalogger>`."
+msgstr ":doc:`Meer informatie kun je hier terugvinden</how-to/installation/remote-datalogger>`."
 
 #: ../../reference/faq.rst:587
 msgid "Prices"

docs/_locale/nl/LC_MESSAGES/tutorial/installation/step-by-step.po

@@ -7,15 +7,16 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DSMR Reader\n"
 "Report-Msgid-Bugs-To: Dennis Siemensma <[email protected]>\n"
-"POT-Creation-Date: 2021-03-14 13:35+0100\n"
+"POT-Creation-Date: 2021-03-14 13:52+0100\n"
 "Last-Translator: Dennis Siemensma <[email protected]>\n"
 "Language: nl\n"
 "Language-Team: Dennis Siemensma <[email protected]>\n"
-"Plural-Forms: nplurals=2; plural=(n != 1)\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Generated-By: Babel 2.9.0\n"
+"X-Generator: Poedit 2.0.6\n"
 
 #: ../../tutorial/installation/step-by-step.rst:2
 msgid "Installation: Step by step"
@@ -78,7 +79,7 @@ msgid "If you need to restore a database backup with your existing data, this is
 msgstr "Indien je een back-up van de database wilt terugzetten met je oude gegevens, nu is het moment om dat te doen."
 
 #: ../../tutorial/installation/step-by-step.rst:61
-msgid "Restoring a database backup? :doc:`See hier for instructions </how-to/database/postgresql-restore-backup>`."
+msgid "Restoring a database backup? :doc:`See here for instructions </how-to/database/postgresql-restore-backup>`."
 msgstr "Database back-up terugzetten? :doc:`Zie hier voor instructies </how-to/database/postgresql-restore-backup>`."
 
 #: ../../tutorial/installation/step-by-step.rst:65
@@ -343,5 +344,5 @@ msgid "Want to quit supervisor? Press ``CTRL + D`` to exit supervisor command li
 msgstr "Wil je uit supervisor? Druk dan op ``CTRL + D`` om uit supervisor te gaan."
 
 #: ../../tutorial/installation/step-by-step.rst:298
-msgid ":doc:`Finished? Go to setting up the application<../setting-up>`."
-msgstr ":doc:`Klaar? Ga dan naar applicatie instellen<../setting-up>`."
+msgid ":doc:`Finished? Go to setting up the application</tutorial/setting-up>`."
+msgstr ":doc:`Klaar? Ga dan naar applicatie instellen</tutorial/setting-up>`."

docs/_locale/nl/LC_MESSAGES/tutorial/upgrading/to-v4.po

@@ -34,8 +34,8 @@ msgid "List of changes"
 msgstr "Lijst van wijzigingen"
 
 #: ../../how-to/upgrading/to-v4.rst:17
-msgid ":doc:`See the changelog<../../reference/changelog>`, for ``v4.x releases`` and higher. Check them before updating!"
-msgstr ":doc:`Zie de changelog<../../reference/changelog>`, voor ``v4.x releases`` en hoger. Bekijk ze voordat je update!"
+msgid ":doc:`See the changelog</reference/changelog>`, for ``v4.x releases`` and higher. Check them before updating!"
+msgstr ":doc:`Zie de changelog</reference/changelog>`, voor ``v4.x releases`` en hoger. Bekijk ze voordat je update!"
 
 #: ../../how-to/upgrading/to-v4.rst:21
 msgid "1. Update to the latest ``v3.x`` version"
@@ -109,8 +109,8 @@ msgid "Unsupported settings"
 msgstr "Niet-ondersteunde instellingen"
 
 #: ../../how-to/upgrading/to-v4.rst:139
-msgid "Not all previously available settings are also supported in ``.env``. See :doc:`Env Settings for the latest list of env vars supported<../../reference/env-settings>`."
-msgstr "Niet alle instellingen zijn nog steeds, of onder dezelfde naam, beschikbaar in de nieuwe ``.env``. Zie :doc:`Env-instellingen voor de meest recente lijst van ondersteunde env vars<../../reference/env-settings>`."
+msgid "Not all previously available settings are also supported in ``.env``. See :doc:`Env Settings for the latest list of env vars supported</reference/env-settings>`."
+msgstr "Niet alle instellingen zijn nog steeds, of onder dezelfde naam, beschikbaar in de nieuwe ``.env``. Zie :doc:`Env-instellingen voor de meest recente lijst van ondersteunde env vars</reference/env-settings>`."
 
 #: ../../how-to/upgrading/to-v4.rst:142
 msgid "However, you can still `use any custom Django settings <https://docs.djangoproject.com/en/3.0/ref/settings/>`_ in the ``dsmrreader/settings.py``. For example: ``X_FRAME_OPTIONS`` or ``USE_X_FORWARDED_HOST``."

docs/how-to/admin/set-username-password.rst

@@ -27,11 +27,11 @@ Manual installation
 Docker installation
 ^^^^^^^^^^^^^^^^^^^
 
-The ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` :doc:`as defined in Env Settings<../../reference/env-settings>` will be used for the credentials.
+The ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` :doc:`as defined in Env Settings</reference/env-settings>` will be used for the credentials.
 
 Creating or updating credentials:
 
-- Configure ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` of the :doc:`Env Settings<../../reference/env-settings>`.
+- Configure ``DSMRREADER_ADMIN_USER`` and ``DSMRREADER_ADMIN_PASSWORD`` of the :doc:`Env Settings</reference/env-settings>`.
 
 - Now execute::
 

docs/how-to/installation/quick.rst

@@ -108,4 +108,4 @@ Continue::
 
 .. seealso::
 
-    :doc:`Finished? Go to setting up the application<../../tutorial/setting-up>`.
+    :doc:`Finished? Go to setting up the application</tutorial/setting-up>`.

docs/how-to/installation/remote-datalogger.rst

@@ -22,11 +22,11 @@ Receiving DSMR-reader instance
 ------------------------------
 
 Make sure to first prepare the API at the DSMR-reader instance you'll forward the telegrams to.
-You can enable the API and view/edit the API key used :doc:`in the configuration<../../tutorial/configuration>`.
+You can enable the API and view/edit the API key used :doc:`in the configuration</tutorial/configuration>`.
 
 .. hint::
 
-    If your smart meter only supports DSMR v2 (or you are using a non Dutch smart meter), make sure to change the DSMR version :doc:`in the configuration<../../tutorial/configuration>` as well, to have DSMR-reader parse them correctly.
+    If your smart meter only supports DSMR v2 (or you are using a non Dutch smart meter), make sure to change the DSMR version :doc:`in the configuration</tutorial/configuration>` as well, to have DSMR-reader parse them correctly.
 
 Also, you should disable the datalogger process over there, since you won't be using it anyway::
 

docs/how-to/third-party/docker.rst

@@ -12,4 +12,4 @@ Third party integration: Docker installation
 
 .. seealso::
 
-    :doc:`Finished? Go to setting up the application<../../tutorial/setting-up>`.
+    :doc:`Finished? Go to setting up the application</tutorial/setting-up>`.

docs/reference/api.rst

@@ -44,7 +44,7 @@ Configuration
 Enable API
 ^^^^^^^^^^
 
-The API is disabled by default in the application. You may enable it :doc:`in the configuration<../tutorial/configuration>`.
+The API is disabled by default in the application. You may enable it :doc:`in the configuration</tutorial/configuration>`.
 
 .. image:: ../_static/screenshots/v4/admin/apisettings.png
     :target: ../_static/screenshots/v4/admin/apisettings.png
@@ -53,4 +53,4 @@ The API is disabled by default in the application. You may enable it :doc:`in th
 API key
 ^^^^^^^
 
-A random API key is generated for you by default. You can always view or update it :doc:`in the configuration<../tutorial/configuration>`.
+A random API key is generated for you by default. You can always view or update it :doc:`in the configuration</tutorial/configuration>`.

docs/reference/changelog.rst

@@ -18,12 +18,14 @@ Current version
 v4.14.0 - 2021-xx-xx
 --------------------
 
+- ``Changed``: Rework documentation structure [`#1315 <https://github.com/dsmrreader/dsmr-reader/issues/1315>`_]
 - ``Changed``: Move PVOutput to scheduled process mechanism [`#950 <https://github.com/dsmrreader/dsmr-reader/issues/950>`_]
 - ``Changed``: Move Dropbox to scheduled process mechanism [`#949 <https://github.com/dsmrreader/dsmr-reader/issues/949>`_]
 
 - ``Fixed``: Dashboard responsiveness verbeteren op kleine schermen [`#1320 <https://github.com/dsmrreader/dsmr-reader/issues/1320>`_]
 
 
+
 v4.13.0 - 2021-03-09
 --------------------
 

docs/tutorial/installation/step-by-step.rst

@@ -58,7 +58,7 @@ Optional: Restore a database backup
 
     If you need to restore a database backup with your existing data, this is the moment to do so.
 
-    Restoring a database backup? :doc:`See the FAQ for instructions </how-to/database/postgresql-restore-backup>`.
+    Restoring a database backup? :doc:`See here for instructions </how-to/database/postgresql-restore-backup>`.
 
 
 2. Dependencies
@@ -295,4 +295,4 @@ Want to quit supervisor? Press ``CTRL + D`` to exit supervisor command line.
 
 .. seealso::
 
-    :doc:`Finished? Go to setting up the application<../setting-up>`.
+    :doc:`Finished? Go to setting up the application</tutorial/setting-up>`.

docs/tutorial/upgrading/to-v4.rst

@@ -14,7 +14,7 @@ DSMR-reader ``v4.x`` is backwards incompatible with ``3.x``. You will have to ma
 List of changes
 ^^^^^^^^^^^^^^^
 
-:doc:`See the changelog<../../reference/changelog>`, for ``v4.x releases`` and higher. Check them before updating!
+:doc:`See the changelog</reference/changelog>`, for ``v4.x releases`` and higher. Check them before updating!
 
 
 1. Update to the latest ``v3.x`` version
@@ -137,7 +137,7 @@ Unsupported settings
 --------------------
 
 Not all previously available settings are also supported in ``.env``.
-See :doc:`Env Settings for the latest list of env vars supported<../../reference/env-settings>`.
+See :doc:`Env Settings for the latest list of env vars supported</reference/env-settings>`.
 
 However, you can still `use any custom Django settings <https://docs.djangoproject.com/en/3.0/ref/settings/>`_ in the ``dsmrreader/settings.py``.
 For example: ``X_FRAME_OPTIONS`` or ``USE_X_FORWARDED_HOST``.