Add job to generate dependencies graph (#267)

Author: Guts

.github/workflows/documentation.yml

@@ -57,6 +57,14 @@ jobs:
       - name: Install project as a package
         run: python -m pip install -e .
 
+      # this job must run before installing other dependencies to avoid listing everything
+      - name: Generates dependencies graph page with pipdetree
+        run: |
+          python -m pip install -U "pipdeptree<3"
+          echo -e "\`\`\`{mermaid}" > docs/misc/dependencies.md
+          pipdeptree --exclude pip,pipdeptree,setuptools,wheel --mermaid >> docs/misc/dependencies.md
+          echo -e "\`\`\`" >> docs/misc/dependencies.md
+
       # this job must run before installing other dependencies to avoid listing everything
       - name: Generates licenses page with pip-licences
         run: |

.gitignore

@@ -132,7 +132,9 @@ dmypy.json
 
 version_info.txt
 _logs/
+*.exe
 *.pfx
 docs/misc/licenses.md
+docs/misc/dependencies.md
 QGISDeploymentToolbelt_*Ubuntu*
 tests/fixtures/tmp/*

docs/conf.py

@@ -49,6 +49,7 @@
     "sphinx_argparse_cli",
     "sphinx_copybutton",
     "sphinx_design",
+    "sphinxcontrib.mermaid",
     "sphinxext.opengraph",
 ]
 
@@ -140,6 +141,15 @@
 
 # -- Extension configuration -------------------------------------------------
 
+# mermaid
+mermaid_params = [
+    "--theme",
+    "forest",
+    "--width",
+    "600",
+    "--backgroundColor",
+    "transparent",
+]
 
 # MyST Parser
 myst_enable_extensions = [

docs/misc/credits.md

@@ -1,10 +1,18 @@
 # Credits
 
-## Dependencies
-
 - [Python 3](https://www.python.org/)
 - [PyInstaller](https://www.pyinstaller.org/) to generate the Windows executable
 
+## Dependencies
+
+> Generated with [pipdeptree](https://pypi.org/project/pipdeptree/).
+
+```{include} dependencies.md
+
+```
+
+## Licenses
+
 > Generated with [pip-licenses](https://pypi.org/project/pip-licenses/)
 
 ```{include} licenses.md

requirements/documentation.txt

@@ -3,9 +3,13 @@
 
 furo==2023.*
 myst-parser[linkify]>=0.18,<1.1
-pip-licenses>=4,<5
 sphinx-argparse-cli>=1,<2
 sphinx-autobuild==2021.3.14
 sphinx-copybutton<1
 sphinx-design>=0.3,<0.5
+sphinxcontrib-mermaid<1
 sphinxext-opengraph>=0.4,<1
+
+# -- 'HIDDEN' dependencies, used during CI
+# pip-licenses<5
+# pipdeptree<3