diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5286f7f65..3e9267eda 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -13,3 +13,8 @@ updates: - "aelsabbahy" open-pull-requests-limit: 0 + - package-ecosystem: "pip" + directory: "/docs" + schedule: + interval: "weekly" + day: "saturday" diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 6a80c4abd..91c39a51f 100644 --- a/.github/workflows/docs.yaml +++ b/.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 diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3166424d8..015eb5de8 100644 --- a/.readthedocs.yaml +++ b/.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 diff --git a/Makefile b/Makefile index dfbac4da0..6d4cf159c 100644 --- a/Makefile +++ b/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) diff --git a/docs/requirements.pip b/docs/requirements.txt similarity index 85% rename from docs/requirements.pip rename to docs/requirements.txt index cfa4c09da..58910536a 100644 --- a/docs/requirements.pip +++ b/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 - diff --git a/mkdocs.yml b/mkdocs.yml index 547aaaa90..df2a127ff 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,6 +46,9 @@ plugins: - awesome-pages - macros: render_by_default: false + - exclude: + glob: + - requirements.txt markdown_extensions: - abbr