diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index e37ff731d2..5548fcfac8 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -101,8 +101,6 @@ jobs: timeout-minutes: 10 name: "mkdocs" runs-on: ubuntu-latest - env: - MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} steps: - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: @@ -110,15 +108,6 @@ jobs: persist-credentials: false - uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # v7.1.4 - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0 - - name: "Add SSH key" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1 - with: - ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} - - - name: "Build docs (public)" - run: uvx --with-requirements docs/requirements.txt mkdocs build --strict -f mkdocs.public.yml - - name: "Build docs (insiders)" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: uvx --with-requirements docs/requirements-insiders.txt mkdocs build --strict -f mkdocs.insiders.yml + - name: "Build docs" + run: uvx --with-requirements docs/requirements.txt mkdocs build --strict -f mkdocs.yml diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index 5c2a411bd3..acc5682497 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -23,8 +23,6 @@ permissions: jobs: mkdocs: runs-on: ubuntu-latest - env: - MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} steps: - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0 with: @@ -62,27 +60,11 @@ jobs: echo "branch_name=update-docs-$branch_display_name-$timestamp" >> "$GITHUB_ENV" echo "timestamp=$timestamp" >> "$GITHUB_ENV" - - name: "Add SSH key" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - uses: webfactory/ssh-agent@a6f90b1f127823b31d4d4a8d96047790581349bd # v0.9.1 - with: - ssh-private-key: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY }} - - - name: "Install Insiders dependencies" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: pip install -r docs/requirements-insiders.txt - - name: "Install dependencies" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} run: pip install -r docs/requirements.txt - - name: "Build Insiders docs" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS == 'true' }} - run: mkdocs build --strict -f mkdocs.insiders.yml - - name: "Build docs" - if: ${{ env.MKDOCS_INSIDERS_SSH_KEY_EXISTS != 'true' }} - run: mkdocs build --strict -f mkdocs.public.yml + run: mkdocs build --strict -f mkdocs.yml - name: "Clone docs repo" run: git clone https://${{ secrets.ASTRAL_DOCS_PAT }}@github.com/astral-sh/docs.git astral-docs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9209d8693..8e505fa3e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -104,22 +104,16 @@ git add ruff To preview any changes to the documentation locally run the development server with: ```shell -# For contributors. -uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.public.yml - -# For members of the Astral org, which has access to MkDocs Insiders via sponsorship. -uvx --with-requirements docs/requirements-insiders.txt -- mkdocs serve -f mkdocs.insiders.yml +uvx --with-requirements docs/requirements.txt -- mkdocs serve -f mkdocs.yml ``` The documentation should then be available locally at [http://127.0.0.1:8000/ty/](http://127.0.0.1:8000/ty/). -To update the documentation dependencies, edit `docs/requirements.in` and -`docs/requirements-insiders.in`, then run: +To update the documentation dependencies, edit `docs/requirements.in`, then run: ```shell uv pip compile docs/requirements.in -o docs/requirements.txt --universal -p 3.12 -uv pip compile docs/requirements-insiders.in -o docs/requirements-insiders.txt --universal -p 3.12 ``` Documentation is deployed automatically on release by publishing to the diff --git a/docs/requirements-insiders.in b/docs/requirements-insiders.in deleted file mode 100644 index 5a462fedeb..0000000000 --- a/docs/requirements-insiders.in +++ /dev/null @@ -1,2 +0,0 @@ --r requirements.in -mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4 diff --git a/docs/requirements-insiders.txt b/docs/requirements-insiders.txt deleted file mode 100644 index afdf050c12..0000000000 --- a/docs/requirements-insiders.txt +++ /dev/null @@ -1,154 +0,0 @@ -# This file was autogenerated by uv via the following command: -# uv pip compile docs/requirements-insiders.in -o docs/requirements-insiders.txt --universal -p 3.12 -babel==2.15.0 - # via - # mkdocs-git-revision-date-localized-plugin - # mkdocs-material -beautifulsoup4==4.13.4 - # via - # markdownify - # mkdocs-llmstxt -black==23.10.0 - # via -r docs/requirements.in -certifi==2024.7.4 - # via requests -charset-normalizer==3.3.2 - # via requests -click==8.1.7 - # via - # black - # mkdocs -colorama==0.4.6 - # via - # click - # mkdocs - # mkdocs-material -ghp-import==2.1.0 - # via mkdocs -gitdb==4.0.12 - # via gitpython -gitpython==3.1.44 - # via mkdocs-git-revision-date-localized-plugin -idna==3.7 - # via requests -jinja2==3.1.4 - # via - # mkdocs - # mkdocs-material -linkify-it-py==2.0.3 - # via markdown-it-py -markdown==3.6 - # via - # mkdocs - # mkdocs-material - # pymdown-extensions -markdown-it-py==3.0.0 - # via - # mdformat - # mdformat-gfm - # mdit-py-plugins -markdownify==1.1.0 - # via mkdocs-llmstxt -markupsafe==2.1.5 - # via - # jinja2 - # mkdocs -mdformat==0.7.22 - # via - # -r docs/requirements.in - # mdformat-admon - # mdformat-gfm - # mdformat-mkdocs - # mdformat-tables - # mkdocs-llmstxt -mdformat-admon==2.0.2 - # via - # -r docs/requirements.in - # mdformat-mkdocs -mdformat-gfm==0.3.6 - # via mdformat-mkdocs -mdformat-mkdocs==2.0.4 - # via -r docs/requirements.in -mdformat-tables==0.4.1 - # via mdformat-gfm -mdit-py-plugins==0.4.1 - # via - # mdformat-admon - # mdformat-gfm -mdurl==0.1.2 - # via markdown-it-py -mergedeep==1.3.4 - # via - # mkdocs - # mkdocs-material -mkdocs==1.5.0 - # via - # -r docs/requirements.in - # mkdocs-git-revision-date-localized-plugin - # mkdocs-material - # mkdocs-redirects -mkdocs-git-revision-date-localized-plugin==1.3.0 - # via -r docs/requirements.in -mkdocs-llmstxt==0.2.0 - # via -r docs/requirements.in -mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4 - # via - # -r docs/requirements-insiders.in - # -r docs/requirements.in -mkdocs-material-extensions==1.3.1 - # via mkdocs-material -mkdocs-redirects==1.2.2 - # via -r docs/requirements.in -more-itertools==10.3.0 - # via mdformat-mkdocs -mypy-extensions==1.0.0 - # via black -packaging==24.1 - # via - # black - # mkdocs -paginate==0.5.6 - # via mkdocs-material -pathspec==0.12.1 - # via - # black - # mkdocs -platformdirs==4.2.2 - # via - # black - # mkdocs -pygments==2.18.0 - # via mkdocs-material -pymdown-extensions==10.8.1 - # via mkdocs-material -python-dateutil==2.9.0.post0 - # via ghp-import -pytz==2025.1 - # via mkdocs-git-revision-date-localized-plugin -pyyaml==6.0.1 - # via - # mkdocs - # pymdown-extensions - # pyyaml-env-tag -pyyaml-env-tag==0.1 - # via mkdocs -regex==2022.10.31 - # via mkdocs-material -requests==2.32.3 - # via mkdocs-material -six==1.16.0 - # via - # markdownify - # python-dateutil -smmap==5.0.2 - # via gitdb -soupsieve==2.7 - # via beautifulsoup4 -typing-extensions==4.14.0 - # via beautifulsoup4 -uc-micro-py==1.0.3 - # via linkify-it-py -urllib3==2.2.2 - # via requests -watchdog==4.0.1 - # via mkdocs diff --git a/docs/requirements.in b/docs/requirements.in index 3cc0f6a253..c3069bd51e 100644 --- a/docs/requirements.in +++ b/docs/requirements.in @@ -1,6 +1,6 @@ black>=23.10.0 mkdocs>=1.5.0 -mkdocs-material>=9.1.18 +mkdocs-material>=9.7.0 mkdocs-redirects>=1.2.1 mdformat>=0.7.17 mdformat-mkdocs>=2.0.4 diff --git a/docs/requirements.txt b/docs/requirements.txt index 41c93098a1..bc945167b5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,6 +4,8 @@ babel==2.15.0 # via # mkdocs-git-revision-date-localized-plugin # mkdocs-material +backrefs==6.1 + # via mkdocs-material beautifulsoup4==4.13.4 # via # markdownify @@ -94,7 +96,7 @@ mkdocs-git-revision-date-localized-plugin==1.3.0 # via -r docs/requirements.in mkdocs-llmstxt==0.2.0 # via -r docs/requirements.in -mkdocs-material==9.5.29 +mkdocs-material==9.7.0 # via -r docs/requirements.in mkdocs-material-extensions==1.3.1 # via mkdocs-material @@ -134,8 +136,6 @@ pyyaml==6.0.1 # pyyaml-env-tag pyyaml-env-tag==0.1 # via mkdocs -regex==2024.5.15 - # via mkdocs-material requests==2.32.3 # via mkdocs-material six==1.16.0 diff --git a/mkdocs.insiders.yml b/mkdocs.insiders.yml deleted file mode 100644 index 78bf106580..0000000000 --- a/mkdocs.insiders.yml +++ /dev/null @@ -1,4 +0,0 @@ -INHERIT: mkdocs.template.yml - -watch: - - mkdocs.template.yml diff --git a/mkdocs.public.yml b/mkdocs.public.yml deleted file mode 100644 index 2a4df16e92..0000000000 --- a/mkdocs.public.yml +++ /dev/null @@ -1,6 +0,0 @@ -# NOTE: Usually, you should edit the template instead. -# This file is used for forks and contributors, production uses `mkdocs.insiders.yml`. -INHERIT: mkdocs.template.yml - -watch: - - mkdocs.template.yml diff --git a/mkdocs.template.yml b/mkdocs.yml similarity index 97% rename from mkdocs.template.yml rename to mkdocs.yml index 2b24593c3a..5fa13cc7db 100644 --- a/mkdocs.template.yml +++ b/mkdocs.yml @@ -18,7 +18,6 @@ theme: - content.code.copy - content.tabs.link palette: - # Note: Using the system theme works with the insiders version # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode - media: "(prefers-color-scheme)" toggle: