mirror of https://github.com/astral-sh/uv
Drop mkdocs from CI
This commit is contained in:
parent
bbcd26224f
commit
f9e38f02de
|
|
@ -480,10 +480,8 @@ jobs:
|
|||
|
||||
docs:
|
||||
timeout-minutes: 10
|
||||
name: "mkdocs"
|
||||
name: "build documentation"
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
with:
|
||||
|
|
@ -493,19 +491,8 @@ jobs:
|
|||
with:
|
||||
version: "0.9.7"
|
||||
|
||||
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.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 zensical build --strict -f mkdocs.public.yml
|
||||
|
||||
build-binary-linux-libc:
|
||||
timeout-minutes: 10
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
#
|
||||
# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a post-announce
|
||||
# job within `cargo-dist`.
|
||||
name: mkdocs
|
||||
name: documentation
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
|
@ -20,11 +20,10 @@ on:
|
|||
permissions: {}
|
||||
|
||||
jobs:
|
||||
mkdocs:
|
||||
publish-documentation:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
VERSION: ${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }}
|
||||
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
|
||||
steps:
|
||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||
with:
|
||||
|
|
@ -63,27 +62,8 @@ 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: uvx build --with-requirements docs/requirements.txt zensical build --strict -f mkdocs.public.yml
|
||||
|
||||
- name: "Clone docs repo"
|
||||
run: |
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ perf.data.old
|
|||
profile.json
|
||||
profile.json.gz
|
||||
|
||||
# MkDocs
|
||||
# Documentation
|
||||
/site
|
||||
|
||||
# macOS
|
||||
|
|
|
|||
|
|
@ -167,11 +167,7 @@ To preview any changes to the documentation locally:
|
|||
3. 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 -- zensical serve -f mkdocs.public.yml
|
||||
```
|
||||
|
||||
The documentation should then be available locally at
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
-r requirements.in
|
||||
mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4
|
||||
|
|
@ -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
|
||||
|
|
@ -1,7 +1,5 @@
|
|||
black>=23.10.0
|
||||
mkdocs>=1.5.0
|
||||
mkdocs-material>=9.1.18
|
||||
mkdocs-redirects>=1.2.1
|
||||
zensical
|
||||
mdformat>=0.7.17
|
||||
mdformat-mkdocs>=2.0.4
|
||||
mdformat-admon>=2.0.2
|
||||
|
|
|
|||
|
|
@ -1,4 +0,0 @@
|
|||
INHERIT: mkdocs.template.yml
|
||||
|
||||
watch:
|
||||
- mkdocs.template.yml
|
||||
|
|
@ -1,5 +1,4 @@
|
|||
# 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:
|
||||
|
|
|
|||
Loading…
Reference in New Issue