Fix dependencies problems with docs CI

.github/workflows/build_docs.yml

@@ -27,5 +27,5 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material
+      - run: pip install -r requirements-docs.tx
       - run: mkdocs gh-deploy --force

Makefile

@@ -13,6 +13,11 @@ install: .poetry .pre-commit
 	poetry install
 	pre-commit install --install-hooks
 
+.PHONY: update  ## Update all libraries and export the requirements
+update:
+	poetry update
+	poetry export -o requirements-docs.txt --only=docs --without-hashes
+
 .PHONY: lint  ## Lint python source files
 lint: .poetry
 	poetry run ruff check $(sources)

pyproject.toml

@@ -21,15 +21,18 @@ pandas = "^2.2.1"
 pytest = "^8.1.1"
 ipykernel = "^6.29.3"
 pyinstrument = "^4.6.2"
+ruff = "^0.3.4"
+
+[tool.poetry.group.docs.dependencies]
 mkdocs-material = "^9.5.15"
-mkdocstrings = {extras = ["python"], version = "^0.24.1"}
+mkdocstrings = { extras = ["python"], version = "^0.24.1" }
 mkdocs-gen-files = "^0.5.0"
 mkdocs-literate-nav = "^0.6.1"
 mkdocs-section-index = "^0.3.8"
 markdown-katex = "^202112.1034"
-black = "^24.3.0"
 mkdocs-glightbox = "^0.3.7"
-ruff = "^0.3.4"
+black = "^24.3.0"
+
 
 [build-system]
 requires = ["poetry-core"]

requirements-docs.txt

@@ -0,0 +1,46 @@
+babel==2.14.0 ; python_version >= "3.9" and python_version < "3.13"
+black==24.3.0 ; python_version >= "3.9" and python_version < "3.13"
+certifi==2024.2.2 ; python_version >= "3.9" and python_version < "3.13"
+charset-normalizer==3.3.2 ; python_version >= "3.9" and python_version < "3.13"
+click==8.1.7 ; python_version >= "3.9" and python_version < "3.13"
+colorama==0.4.6 ; python_version >= "3.9" and python_version < "3.13"
+ghp-import==2.1.0 ; python_version >= "3.9" and python_version < "3.13"
+griffe==0.42.1 ; python_version >= "3.9" and python_version < "3.13"
+idna==3.6 ; python_version >= "3.9" and python_version < "3.13"
+importlib-metadata==7.1.0 ; python_version >= "3.9" and python_version < "3.10"
+jinja2==3.1.3 ; python_version >= "3.9" and python_version < "3.13"
+markdown-katex==202112.1034 ; python_version >= "3.9" and python_version < "3.13"
+markdown==3.5.2 ; python_version >= "3.9" and python_version < "3.13"
+markupsafe==2.1.5 ; python_version >= "3.9" and python_version < "3.13"
+mergedeep==1.3.4 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-autorefs==1.0.1 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-gen-files==0.5.0 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-glightbox==0.3.7 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-literate-nav==0.6.1 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-material-extensions==1.3.1 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-material==9.5.15 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs-section-index==0.3.8 ; python_version >= "3.9" and python_version < "3.13"
+mkdocs==1.5.3 ; python_version >= "3.9" and python_version < "3.13"
+mkdocstrings-python==1.9.0 ; python_version >= "3.9" and python_version < "3.13"
+mkdocstrings==0.24.1 ; python_version >= "3.9" and python_version < "3.13"
+mkdocstrings[python]==0.24.1 ; python_version >= "3.9" and python_version < "3.13"
+mypy-extensions==1.0.0 ; python_version >= "3.9" and python_version < "3.13"
+packaging==24.0 ; python_version >= "3.9" and python_version < "3.13"
+paginate==0.5.6 ; python_version >= "3.9" and python_version < "3.13"
+pathlib2==2.3.7.post1 ; python_version >= "3.9" and python_version < "3.13"
+pathspec==0.12.1 ; python_version >= "3.9" and python_version < "3.13"
+platformdirs==4.2.0 ; python_version >= "3.9" and python_version < "3.13"
+pygments==2.17.2 ; python_version >= "3.9" and python_version < "3.13"
+pymdown-extensions==10.7.1 ; python_version >= "3.9" and python_version < "3.13"
+python-dateutil==2.9.0.post0 ; python_version >= "3.9" and python_version < "3.13"
+pyyaml-env-tag==0.1 ; python_version >= "3.9" and python_version < "3.13"
+pyyaml==6.0.1 ; python_version >= "3.9" and python_version < "3.13"
+regex==2023.12.25 ; python_version >= "3.9" and python_version < "3.13"
+requests==2.31.0 ; python_version >= "3.9" and python_version < "3.13"
+setuptools==69.2.0 ; python_version >= "3.9" and python_version < "3.13"
+six==1.16.0 ; python_version >= "3.9" and python_version < "3.13"
+tomli==2.0.1 ; python_version >= "3.9" and python_version < "3.11"
+typing-extensions==4.10.0 ; python_version >= "3.9" and python_version < "3.11"
+urllib3==2.2.1 ; python_version >= "3.9" and python_version < "3.13"
+watchdog==4.0.0 ; python_version >= "3.9" and python_version < "3.13"
+zipp==3.18.1 ; python_version >= "3.9" and python_version < "3.10"

scripts/gen_doc_stubs.py

@@ -7,7 +7,7 @@
 nav = mkdocs_gen_files.Nav()
 
 root = Path(__file__).parent.parent
-src = root / "src" 
+src = root / "src"
 
 for path in sorted(src.rglob("*.py")):
     module_path = path.relative_to(src).with_suffix("")