From 0d0c54e09fe9269236f0baaaae42505e051f4ed1 Mon Sep 17 00:00:00 2001 From: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com> Date: Sat, 25 Jul 2026 02:32:46 -0700 Subject: [PATCH] ci(docs): migrate from mkdocs to properdocs (#1459) * ci(docs): migrate from mkdocs to properdocs * ci(docs): remove extraneous env --------- Co-authored-by: Xarvex <60973030+xarvex@users.noreply.github.com> --- .github/workflows/build_docs.yml | 8 +++----- mkdocs.yml => properdocs.yml | 0 pyproject.toml | 6 +++++- 3 files changed, 8 insertions(+), 6 deletions(-) rename mkdocs.yml => properdocs.yml (100%) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 4aa84bb5..a1202c9a 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -13,7 +13,7 @@ on: - .github/actions/setup-python/action.yml - .github/workflows/build_docs.yml - docs/** - - mkdocs.yml + - properdocs.yml workflow_dispatch: concurrency: @@ -50,7 +50,5 @@ jobs: path: .cache restore-keys: | mkdocs-material- - - name: Run mkdocs - env: - DISABLE_MKDOCS_2_WARNING: 'true' - run: mkdocs gh-deploy --force + - name: Run properdocs + run: properdocs gh-deploy --force diff --git a/mkdocs.yml b/properdocs.yml similarity index 100% rename from mkdocs.yml rename to properdocs.yml diff --git a/pyproject.toml b/pyproject.toml index f2c89783..176eccce 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -60,7 +60,11 @@ extra = [{ include-group = "pre-commit" }] lint = [{ include-group = "pyright" }, { include-group = "ruff" }] test = [{ include-group = "pytest" }] -mkdocs = ["mkdocs-material[imaging]>=9.7", "mkdocs-redirects~=1.2"] +mkdocs = [ + "mkdocs-material[imaging]>=9.7", + "mkdocs-redirects~=1.2", + "properdocs", +] pre-commit = ["pre-commit~=4.2"] pyinstaller = ["Pyinstaller~=6.21"] pyright = ["pyright~=1.1.409"]