feedback: #115 (comment)

docs/conf.py

@@ -1,66 +1,31 @@
 # Configuration file for the Sphinx documentation builder.
 #
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
 # -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "GPP-app"
-copyright = "ICATT Interactive Media 2024"
-author = "ICATT"
-
+project = 'GPP-app'
+copyright = '2024, ICATT'
+author = 'ICATT'
 
 # -- General configuration ---------------------------------------------------
-# -- General configuration
-
-extensions = [
-    "sphinx.ext.duration",
-    "sphinx.ext.doctest",
-    "sphinx.ext.autodoc",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.intersphinx",
-]
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-intersphinx_mapping = {
-    "rtd": ("https://docs.readthedocs.io/en/stable/", None),
-    "python": ("https://docs.python.org/3/", None),
-    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
-}
-intersphinx_disabled_domains = ["std"]
+extensions = []
 
-templates_path = ["_templates"]
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# -- Options for EPUB output
-epub_show_urls = "footnote"
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Options for HTML output -------------------------------------------------
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_logo = "logo.png"
-html_theme = "sphinx_rtd_theme"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+html_logo = 'logo.png'
+html_theme = 'sphinx_rtd_theme'
+html_theme = 'alabaster'
+html_static_path = ['_static']
 html_css_files = [
-    "theme_overrides.css",  # override wide tables with word wrap by Maykin
+    'theme_overrides.css',  # override wide tables with word wrap by Maykin
 ]

docs/index.rst

@@ -1,21 +1,17 @@
-.. _`Wet open overheid (Woo)` : https://wetten.overheid.nl/BWBR0045754/
-.. _`Common Ground`: https://commonground.nl/
+.. GPP-app documentation master file, created by
+   sphinx-quickstart on Mon Dec  9 11:17:06 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
-**<<Under construction!>>**
+GPP-app documentation
+=====================
 
-GPP App
-================
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
 
-The Dutch government wishes to be open and transparent to its citizens. To achieve this,
-the law `Wet open overheid (Woo)`_ was established, 
-requiring government organisations to actively and digitally publish their documents and thus create *public records*.
 
-To support govenment organisations in executing this law, the "Generic Publications Platform Woo (GPP-Woo)" was developed. 
-This platform is an aggregation of four components, including the 'GPP App' component. This component provides public servants with a web-based user interface to manulaly upload and publish public records.
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
-For a full publication platform, two additional components are required:
-
-* `GPP Publications <https://github.com/GPP-Woo/GPP-publicatiebank>`_, a storage repository and JSON API to manage and expose public records including their metadata.
-* `GPP Citizen Portal <https://github.com/GPP-Woo/GPP-burgerportaal>`_, a component which provides citizens with a website where they can browse and search through public records.
-
-All components are designed in line with the `Common Ground`_ model.

docs/requirements.in

@@ -1,2 +1,2 @@
-Sphinx>=5,<6
+sphinx
 sphinx_rtd_theme

docs/requirements.txt

@@ -1,58 +1,55 @@
-#
-# This file is autogenerated by pip-compile with python 3.10
-# To update, run:
-#
-#    pip-compile docs/requirements.in
-#
-alabaster==0.7.12
+# This file was autogenerated by uv via the following command:
+#    uv pip compile --output-file requirements.txt requirements.in
+alabaster==1.0.0
     # via sphinx
-babel==2.10.3
+babel==2.16.0
     # via sphinx
-certifi==2022.6.15
+certifi==2024.8.30
     # via requests
-charset-normalizer==2.1.0
+charset-normalizer==3.4.0
     # via requests
-docutils==0.17.1
+colorama==0.4.6
+    # via sphinx
+docutils==0.21.2
     # via
     #   sphinx
     #   sphinx-rtd-theme
-idna==3.3
+idna==3.10
     # via requests
 imagesize==1.4.1
     # via sphinx
-jinja2==3.1.2
+jinja2==3.1.4
     # via sphinx
-markupsafe==2.1.1
+markupsafe==3.0.2
     # via jinja2
-packaging==21.3
+packaging==24.2
     # via sphinx
-pygments==2.12.0
+pygments==2.18.0
     # via sphinx
-pyparsing==3.0.9
-    # via packaging
-pytz==2022.1
-    # via babel
-requests==2.28.1
+requests==2.32.3
     # via sphinx
 snowballstemmer==2.2.0
     # via sphinx
-sphinx==5.0.2
+sphinx==8.1.3
     # via
-    #   -r docs/requirements.in
+    #   -r requirements.in
     #   sphinx-rtd-theme
-sphinx-rtd-theme==1.0.0
-    # via -r docs/requirements.in
-sphinxcontrib-applehelp==1.0.2
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==3.0.2
+    # via -r requirements.in
+sphinxcontrib-applehelp==2.0.0
     # via sphinx
-sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-devhelp==2.0.0
     # via sphinx
-sphinxcontrib-htmlhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
     # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-qthelp==2.0.0
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.5
+sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
-urllib3==1.26.9
+urllib3==2.2.3
     # via requests