build(deps): freeze requirements for docs

.readthedocs.yaml

@@ -16,19 +16,18 @@ build:
     - libapt-pkg-dev
   jobs:
     post_checkout:
+      - git fetch --unshallow || true # See https://docs.readthedocs.io/en/latest/build-customization.html#unshallow-git-clone
       - git fetch --tags --depth 1 # Also fetch tags
       - git describe               # Useful for debugging
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-  builder: html
+  builder: dirhtml
   fail_on_warning: true
 
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: requirements-docs.txt
     - method: pip
       path: .
-      extra_requirements:
-        - docs

requirements-devel.txt

@@ -1,9 +1,20 @@
+alabaster==0.7.16
 annotated-types==0.7.0
+anyio==4.4.0
+apeye==1.4.1
+apeye-core==1.1.5
 astroid==3.2.4
 attrs==24.2.0
+autodocsumm==0.2.13
+babel==2.16.0
+beautifulsoup4==4.12.3
 black==24.8.0
 boolean.py==4.0
-cachetools==5.4.0
+bracex==2.5
+CacheControl==0.14.0
+cachetools==5.5.0
+canonical-sphinx==0.1.0
+canonical-sphinx-extensions==0.0.23
 catkin-pkg==1.0.0
 certifi==2024.7.4
 cffi==1.17.0
@@ -22,34 +33,53 @@ craft-platforms==0.1.1
 craft-providers==2.0.0
 craft-store==3.0.0
 cryptography==43.0.0
+cssutils==2.11.1
+dict2css==0.3.0.post1
 dill==0.3.8
 distlib==0.3.8
 distro==1.9.0
 docutils==0.19
+domdf-python-tools==3.9.0
 filelock==3.15.4
 fixtures==4.1.0
 flake8==7.1.1
+furo==2024.8.6
+gitdb==4.0.11
+GitPython==3.1.43
 gnupg==2.3.1
+h11==0.14.0
+html5lib==1.1
 httplib2==0.22.0
 hupper==1.12.1
 idna==3.7
+imagesize==1.4.1
 importlib_metadata==8.2.0
 iniconfig==2.0.0
 isort==5.13.2
 jaraco.classes==3.4.0
 jeepney==0.8.0
+Jinja2==3.1.4
 jsonschema==2.5.1
 keyring==24.3.1
 launchpadlib==2.0.0
 lazr.restfulclient==0.14.6
 lazr.uri==1.0.6
 license-expression==30.3.1
+linkify-it-py==2.0.3
 lxml==5.3.0
 macaroonbakery==1.3.4
+Markdown==3.7
+markdown-it-py==3.0.0
+MarkupSafe==2.1.5
 mccabe==0.7.0
+mdit-py-plugins==0.4.1
+mdurl==0.1.2
 more-itertools==10.4.0
+msgpack==1.0.8
 mypy==1.11.1
 mypy-extensions==1.0.0
+myst-parser==4.0.0
+natsort==8.4.0
 oauthlib==3.2.2
 overrides==7.7.0
 packaging==24.1
@@ -61,6 +91,7 @@ plaster==1.1.2
 plaster-pastedeploy==1.0.1
 platformdirs==4.2.2
 pluggy==1.5.0
+polib==1.2.0
 progressbar==2.5
 protobuf==5.27.3
 psutil==6.0.0
@@ -75,6 +106,7 @@ pyelftools==0.31
 pyflakes==3.2.0
 pyftpdlib==1.5.10
 pygit2==1.13.3
+Pygments==2.18.0
 pylint==3.2.6
 pylxd==2.3.4
 pymacaroons==0.13.0
@@ -83,6 +115,7 @@ pyparsing==3.1.2
 pyproject-api==1.7.1
 pyramid==2.0.2
 pyRFC3339==1.1
+pyspelling==2.10
 pytest==8.3.2
 pytest-cov==5.0.0
 pytest-mock==3.14.0
@@ -93,6 +126,7 @@ pytz==2024.1
 pyxdg==0.28
 PyYAML==6.0.2
 raven==6.10.0
+regex==2024.7.24
 requests==2.31.0
 requests-toolbelt==1.0.0
 requests-unixsocket==0.3.0
@@ -102,8 +136,34 @@ SecretStorage==3.3.3
 setuptools==72.2.0
 simplejson==3.19.3
 six==1.16.0
+smmap==5.0.1
 snap-helpers==0.4.2
+sniffio==1.3.1
 snowballstemmer==2.2.0
+soupsieve==2.6
+Sphinx==7.3.7
+sphinx-autobuild==2024.4.16
+sphinx-autodoc-typehints==2.2.3
+sphinx-basic-ng==1.0.0b2
+sphinx-copybutton==0.5.2
+sphinx-jinja2-compat==0.3.0
+sphinx-lint==0.9.1
+sphinx-notfound-page==1.0.4
+sphinx-prompt==1.8.0
+sphinx-tabs==3.4.5
+sphinx-toolbox==3.8.0
+sphinx_design==0.6.1
+sphinx_reredirects==0.1.5
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-details-directive==0.1.0
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
+sphinxcontrib-jquery==4.1
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
+sphinxext-opengraph==0.9.1
+starlette==0.38.2
 tabulate==0.9.0
 testscenarios==0.5.0
 testtools==2.7.2
@@ -114,23 +174,29 @@ tox==4.18.0
 translationstring==1.4
 types-PyYAML==6.0.12.20240808
 types-requests==2.31.0.6
-types-setuptools==71.1.0.20240813
+types-setuptools==71.1.0.20240818
 types-simplejson==3.19.0.20240801
 types-tabulate==0.9.0.20240106
 types-toml==0.10.8.20240310
 types-urllib3==1.26.25.14
 typing_extensions==4.12.2
+uc-micro-py==1.0.3
 urllib3==1.26.19
+uvicorn==0.30.6
 validators==0.33.0
 venusian==3.1.0
 virtualenv==20.26.3
 wadllib==1.3.6
+watchfiles==0.23.0
+wcmatch==9.0
+webencodings==0.5.1
 WebOb==1.8.8
+websockets==12.0
 wheel==0.44.0
 ws4py==0.5.1
 yamllint==1.35.1
 zipp==3.20.0
 zope.deprecation==5.0
 zope.interface==7.0.1
 python-apt @ https://launchpad.net/ubuntu/+archive/primary/+sourcefiles/python-apt/2.4.0ubuntu1/python-apt_2.4.0ubuntu1.tar.xz; sys.platform == "linux"
-pyinstaller==5.13.2; sys.platform == "win32"
+pyinstaller==5.13.1; sys.platform == "win32"

docs/requirements.txt → requirements-docs.txt

@@ -1,9 +1,15 @@
 alabaster==0.7.16
-anyio==4.3.0
-attrs==23.2.0
-Babel==2.14.0
+annotated-types==0.7.0
+anyio==4.4.0
+apeye==1.4.1
+apeye-core==1.1.5
+attrs==24.2.0
+autodocsumm==0.2.13
+babel==2.16.0
 beautifulsoup4==4.12.3
-bracex==2.4
+boolean.py==4.0
+bracex==2.5
+CacheControl==0.14.0
 canonical-sphinx==0.1.0
 canonical-sphinx-extensions==0.0.23
 catkin-pkg==1.0.0
@@ -21,112 +27,124 @@ craft-parts==2.0.0
 craft-platforms==0.1.1
 craft-providers==2.0.0
 craft-store==3.0.0
-cryptography==42.0.8
-Deprecated==1.2.14
+cryptography==43.0.0
+cssutils==2.11.1
+dict2css==0.3.0.post1
 distro==1.9.0
 docutils==0.19
-exceptiongroup==1.2.2
-furo==2024.5.6
+domdf-python-tools==3.9.0
+filelock==3.15.4
+furo==2024.8.6
+gitdb==4.0.11
+GitPython==3.1.43
 gnupg==2.3.1
 h11==0.14.0
 html5lib==1.1
 httplib2==0.22.0
 idna==3.7
 imagesize==1.4.1
-importlib_metadata==7.1.0
+importlib_metadata==8.2.0
 jaraco.classes==3.4.0
 jeepney==0.8.0
 Jinja2==3.1.4
 jsonschema==2.5.1
 keyring==24.3.1
-launchpadlib==1.11.0
+launchpadlib==2.0.0
 lazr.restfulclient==0.14.6
 lazr.uri==1.0.6
+license-expression==30.3.1
 linkify-it-py==2.0.3
-lxml==5.2.1
+lxml==5.3.0
 macaroonbakery==1.3.4
-Markdown==3.6
+Markdown==3.7
 markdown-it-py==3.0.0
 MarkupSafe==2.1.5
 mdit-py-plugins==0.4.1
 mdurl==0.1.2
-more-itertools==10.2.0
+more-itertools==10.4.0
+msgpack==1.0.8
 mypy-extensions==1.0.0
-myst-parser==3.0.1
+myst-parser==4.0.0
+natsort==8.4.0
 oauthlib==3.2.2
 overrides==7.7.0
-packaging==24.0
-pip==23.3.2
+packaging==24.1
 platformdirs==4.2.2
 polib==1.2.0
 progressbar==2.5
-protobuf==5.26.1
-psutil==5.9.8
+protobuf==5.27.3
+psutil==6.0.0
 pycparser==2.22
 pydantic==2.8.2
+pydantic_core==2.20.1
+pydantic_yaml==1.3.0
 pyelftools==0.31
 pygit2==1.13.3
-Pygments==2.17.2
+Pygments==2.18.0
 pylxd==2.3.4
 pymacaroons==0.13.0
 PyNaCl==1.5.0
 pyparsing==3.1.2
 pyRFC3339==1.1
 pyspelling==2.10
-python-apt @ https://launchpad.net/ubuntu/+archive/primary/+sourcefiles/python-apt/2.4.0ubuntu1/python-apt_2.4.0ubuntu1.tar.xz; sys.platform == "linux"
 python-dateutil==2.9.0.post0
 python-debian==0.1.49
 pytz==2024.1
 pyxdg==0.28
 PyYAML==6.0.2
 raven==6.10.0
-regex==2024.4.28
+regex==2024.7.24
 requests==2.31.0
 requests-toolbelt==1.0.0
 requests-unixsocket==0.3.0
+ruamel.yaml==0.18.6
+ruamel.yaml.clib==0.2.8
 SecretStorage==3.3.3
-setuptools==65.5.1
-simplejson==3.19.2
+setuptools==72.2.0
+simplejson==3.19.3
 six==1.16.0
+smmap==5.0.1
 snap-helpers==0.4.2
 sniffio==1.3.1
 snowballstemmer==2.2.0
-soupsieve==2.5
+soupsieve==2.6
 Sphinx==7.3.7
 sphinx-autobuild==2024.4.16
+sphinx-autodoc-typehints==2.2.3
 sphinx-basic-ng==1.0.0b2
 sphinx-copybutton==0.5.2
-sphinx_design==0.5.0
+sphinx-jinja2-compat==0.3.0
 sphinx-lint==0.9.1
 sphinx-notfound-page==1.0.4
-sphinx-reredirects==0.1.5
+sphinx-prompt==1.8.0
 sphinx-tabs==3.4.5
-sphinxcontrib-applehelp==1.0.8
+sphinx-toolbox==3.8.0
+sphinx_design==0.6.1
+sphinx_reredirects==0.1.5
+sphinxcontrib-applehelp==2.0.0
 sphinxcontrib-details-directive==0.1.0
-sphinxcontrib-devhelp==1.0.6
-sphinxcontrib-htmlhelp==2.0.5
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
 sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==1.0.8
-sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
 sphinxext-opengraph==0.9.1
-starlette==0.37.2
+starlette==0.38.2
 tabulate==0.9.0
 tinydb==4.8.0
 toml==0.10.2
-tomli==2.0.1
-types-Deprecated==1.2.9.20240311
-types-PyYAML==6.0.12.20240808
-typing_extensions==4.11.0
+typing_extensions==4.12.2
 uc-micro-py==1.0.3
 urllib3==1.26.19
-uvicorn==0.29.0
-validators==0.28.3
+uvicorn==0.30.6
+validators==0.33.0
 wadllib==1.3.6
-watchfiles==0.21.0
-wcmatch==8.5.2
+watchfiles==0.23.0
+wcmatch==9.0
 webencodings==0.5.1
 websockets==12.0
-wrapt==1.16.0
+wheel==0.44.0
 ws4py==0.5.1
-zipp==3.19.1
+zipp==3.20.0
+python-apt @ https://launchpad.net/ubuntu/+archive/primary/+sourcefiles/python-apt/2.4.0ubuntu1/python-apt_2.4.0ubuntu1.tar.xz; sys.platform == "linux"

setup.py

@@ -143,10 +143,12 @@ def recursive_data_files(directory, install_directory):
 
 docs_requires = {
     "canonical-sphinx",
-    "pyspelling",
-    "sphinxcontrib-details-directive",
     "sphinx-autobuild",
+    "sphinx-autodoc-typehints",
+    "sphinxcontrib-details-directive",
     "sphinx-lint",
+    "sphinx-toolbox",
+    "pyspelling",
 }
 
 extras_requires = {"dev": dev_requires, "docs": docs_requires}