[#29] fix documentation errors

maykinmedia · Jan 29, 2025 · bb8883e · bb8883e
1 parent a3d2f81
commit bb8883e
Show file tree

Hide file tree

Showing 15 changed files with 23 additions and 15 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,7 +1,7 @@
 
 0.0.x (TBD)
 -----------
-* Documentation on https://open-producten.readthedocs.io/
+* Added Read the Docs documentation
 
 0.0.2 (17-01-2025)
 ------------------

diff --git a/docs/client-development/index.rst b/docs/client-development/index.rst
@@ -1,7 +1,7 @@
 .. _client-development:
 
 Open Producten client documentation
-==============================
+===================================
 
 Open Producten is primarily a provider of API's to be consumed by clients. If you're
 developing such a client (or consumer), you're in the right place!

diff --git a/docs/conf.py b/docs/conf.py
@@ -78,6 +78,8 @@
 linkcheck_ignore = [
     r"http://localhost:\d+/",
     r"http://127\.0\.0\.1:\d+/",
+    r"https?://.*\.gemeente.nl",
+    r"http://localhost:\d+,https?://.*\.gemeente.nl",
 ]
 
 sphinx_tabs_valid_builders = ["linkcheck"]
diff --git a/docs/development/getting_started.rst b/docs/development/getting_started.rst
@@ -157,6 +157,7 @@ The file ``includes/local.py`` overwrites settings from the base configuration,
 and is only loaded for the dev settings.
 
 .. TODO: remove Celery part below? No references for usage found in project
+
 Running background tasks
 =====================================
 

diff --git a/docs/development/performance/index.rst b/docs/development/performance/index.rst
@@ -6,7 +6,7 @@ Performance
 .. TODO: include performance benchmarks
 
 The performance for Open Producten can be measured in several ways. See
-:ref:`Profiling <_development_performance_profiling>` for options about measuring
+:ref:`Profiling<development_performance_profiling>` for options about measuring
 several aspects of Open Producten.
 
 .. toctree::

diff --git a/docs/development/releasing.rst b/docs/development/releasing.rst
@@ -65,3 +65,5 @@ Once the PR is merged to main, check out the ``master`` branch and tag it:
     git tag 1.0.0
 
 Tagging will ensure that a Docker image ``maykinmedia/open-producten:1.0.0`` is published.
+
+. _`Maykin`: https://github.com/maykinmedia
diff --git a/docs/development/security.rst b/docs/development/security.rst
@@ -1,5 +1,5 @@
 Security measures in Open Producten
-==============================
+===================================
 
 The following is a non-exhaustive list of configurations in Open Producten to enhance
 security.
@@ -24,7 +24,7 @@ are set in the virtual host:
     there's no need for these :-)
 
 Open Producten settings
-------------------
+-----------------------
 
 ``X-Frame-Options`` is set to ``DENY``
     no (i)frames are allowed at all
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
 Open Producten Documentation
-=======================
+============================
 
 **Open Producten** is an application where product types and products can be
 managed in a single place. Other applications like `Open Inwoner`_ and `Open

diff --git a/docs/installation/config/openproducten_config.rst b/docs/installation/config/openproducten_config.rst
@@ -1,8 +1,8 @@
 .. _installation_configuration:
 
-===============================
+====================================
 Open Producten configuration (admin)
-===============================
+====================================
 
 Before you can work with Open Producten after installation, a few settings need to be
 configured first.
@@ -29,7 +29,7 @@ Create an API token
 ===================
 
 Open Producten
----------
+--------------
 By creating an API token, we can perform an API test call to verify the successful
 installation.
 
@@ -47,7 +47,7 @@ Making an API call
 ==================
 
 Open Producten
----------
+--------------
 We can now make an HTTP request to one of the APIs of Open Producten. For this
 example, we have used `curl`_ to make the request.
 

diff --git a/docs/installation/reference/logging.rst b/docs/installation/reference/logging.rst
@@ -42,7 +42,7 @@ For documentation on how to set up a project in Sentry, please refer to the offi
 documentation (make sure to follow the instructions for the platform Python > Django).
 
 After setting up the project, you will receive a **DSN**, which is the URL to which
-exceptions will be sent (e.g. https://[email protected]/104).
+exceptions will be sent.
 
 The created Sentry project can be linked to Open Producten by setting the environment
 variable ``SENTRY_DSN`` equal to this DSN.

diff --git a/docs/installation/reference/time.rst b/docs/installation/reference/time.rst
@@ -16,7 +16,7 @@ possible, both client and server should use the *same* services so that their cl
 in sync.
 
 Where Open Producten deals with time-aspects
-=======================================
+============================================
 
 Open Producten deals with time-based validations in a number of places, of which you can
 configure how Open Producten deals with them for a subset of these places.

diff --git a/docs/installation/updating.rst b/docs/installation/updating.rst
@@ -1,7 +1,7 @@
 .. _installation_updating:
 
 Updating an Open Producten installation
-==================================
+=======================================
 
 Software receives new features and bugfixes all the time, and Open Producten is no different.
 At some point, you'll want to update to a newer version of Open Producten - be it a patch

diff --git a/docs/introduction/open-source/index.rst b/docs/introduction/open-source/index.rst
@@ -8,6 +8,9 @@ Open Producten is open-source and available under the `EUPL license`_.
 In addition, this project makes use of various open-source `Python libraries`_
 under the hood.
 
+.. _`EUPL license`: https://github.com/maykinmedia/open-producten/blob/master/LICENSE.md
+.. _`Python libraries`: https://github.com/maykinmedia/open-producten/blob/master/requirements/base.txt
+
 .. toctree::
    :maxdepth: 1
 

diff --git a/docs/introduction/team.rst b/docs/introduction/team.rst
@@ -1,5 +1,5 @@
 Who's behind Open Producten?
-=======================
+============================
 
 
 .. TODO:

diff --git a/docs/manual/oidc.rst b/docs/manual/oidc.rst
@@ -39,7 +39,7 @@ Aan het eind van dit proces moet je de volgende gegevens hebben (on premise):
 * Client secret, bijvoorbeeld ``97d663a9-3624-4930-90c7-2b90635bd990``
 
 Configureren van OIDC in Open Producten
-==================================
+=======================================
 
 Zorg dat je de volgende :ref:`gegevens <manual_oidc_appgroup>` hebt:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -65,3 +65,5 @@ Once the PR is merged to main, check out the ``master`` branch and tag it:
		git tag 1.0.0

		Tagging will ensure that a Docker image ``maykinmedia/open-producten:1.0.0`` is published.

		. _`Maykin`: https://github.com/maykinmedia