Fix building mkdocs (#900)

* Build mkdocs to gh-pages

* rename requirements.pip to requirements.txt

* exclude requirements from doc deployment

* add docs python to dependabot

* fix wrong merge

* bring back Upload artifact action

.github/dependabot.yml

@@ -13,3 +13,8 @@ updates:
       - "aelsabbahy"
     open-pull-requests-limit: 0
 
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "weekly"
+      day: "saturday"

.github/workflows/docs.yaml

@@ -30,18 +30,18 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
+          python-version: "3.12"
           cache: 'pip'
       - name: Install dependencies
         run: |
           pip install --upgrade pip
-          pip install --requirement docs/requirements.pip
+          pip install --requirement docs/requirements.txt
       - name: Build documentation
         run: mkdocs build
       # To remove if not using github pages
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3
         with:
           path: site

.readthedocs.yaml

@@ -16,4 +16,4 @@ mkdocs:
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-  - requirements: docs/requirements.pip
+  - requirements: docs/requirements.txt

Makefile

@@ -140,10 +140,10 @@ $(PYTHON):
 	$(info Creating virtualenv in $(VENV))
 	@python -m venv $(VENV)
 
-$(DOCS_DEPS): $(PYTHON) docs/requirements.pip
+$(DOCS_DEPS): $(PYTHON) docs/requirements.txt
 	$(info Installing dependencies)
 	@pip install --upgrade pip
-	@pip install --requirement docs/requirements.pip
+	@pip install --requirement docs/requirements.txt
 	@touch $(DOCS_DEPS)
 
 docs/setup: $(DOCS_DEPS)

docs/requirements.pip → docs/requirements.txt

@@ -1,6 +1,6 @@
 mkdocs-material==9.5.3
 mkdocs-macros-plugin==1.0.5
 mkdocs-awesome-pages-plugin==2.9.2
+mkdocs-exclude==1.0.2
 mdx-breakless-lists==1.0.1
 pygments==2.17.2
-

mkdocs.yml

@@ -46,6 +46,9 @@ plugins:
   - awesome-pages
   - macros:
       render_by_default: false
+  - exclude:
+       glob:
+         - requirements.txt
 
 markdown_extensions:
   - abbr