Move content from the mkdocs.public.yml into the template (#11246)

Closes https://github.com/astral-sh/uv/issues/11242
This commit is contained in:
Zanie Blue 2025-02-05 10:13:46 -06:00 committed by GitHub
parent acbbb2b82a
commit 1f963d1b89
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 22 additions and 8 deletions

View file

@ -397,6 +397,8 @@ jobs:
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }} MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: astral-sh/setup-uv@v5 - uses: astral-sh/setup-uv@v5
- uses: actions/setup-python@v5 - uses: actions/setup-python@v5
- name: "Add SSH key" - name: "Add SSH key"

View file

@ -1,7 +1,9 @@
# This file was autogenerated by uv via the following command: # 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 # uv pip compile docs/requirements-insiders.in -o docs/requirements-insiders.txt --universal -p 3.12
babel==2.15.0 babel==2.15.0
# via mkdocs-material # via
# mkdocs-git-revision-date-localized-plugin
# mkdocs-material
black==23.10.0 black==23.10.0
# via -r docs/requirements.in # via -r docs/requirements.in
certifi==2024.7.4 certifi==2024.7.4
@ -19,6 +21,10 @@ colorama==0.4.6
# mkdocs-material # mkdocs-material
ghp-import==2.1.0 ghp-import==2.1.0
# via mkdocs # via mkdocs
gitdb==4.0.12
# via gitpython
gitpython==3.1.44
# via mkdocs-git-revision-date-localized-plugin
idna==3.7 idna==3.7
# via requests # via requests
jinja2==3.1.4 jinja2==3.1.4
@ -71,8 +77,11 @@ mergedeep==1.3.4
mkdocs==1.5.0 mkdocs==1.5.0
# via # via
# -r docs/requirements.in # -r docs/requirements.in
# mkdocs-git-revision-date-localized-plugin
# mkdocs-material # mkdocs-material
# mkdocs-redirects # mkdocs-redirects
mkdocs-git-revision-date-localized-plugin==1.3.0
# via -r docs/requirements.in
mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4 mkdocs-material @ git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4
# via # via
# -r docs/requirements-insiders.in # -r docs/requirements-insiders.in
@ -105,6 +114,8 @@ pymdown-extensions==10.8.1
# via mkdocs-material # via mkdocs-material
python-dateutil==2.9.0.post0 python-dateutil==2.9.0.post0
# via ghp-import # via ghp-import
pytz==2025.1
# via mkdocs-git-revision-date-localized-plugin
pyyaml==6.0.1 pyyaml==6.0.1
# via # via
# mkdocs # mkdocs
@ -118,6 +129,8 @@ requests==2.32.3
# via mkdocs-material # via mkdocs-material
six==1.16.0 six==1.16.0
# via python-dateutil # via python-dateutil
smmap==5.0.2
# via gitdb
uc-micro-py==1.0.3 uc-micro-py==1.0.3
# via linkify-it-py # via linkify-it-py
urllib3==2.2.2 urllib3==2.2.2

View file

@ -1,10 +1,6 @@
# 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 INHERIT: mkdocs.template.yml
# Omit the `typeset` plugin which is only available in the Insiders version.
plugins:
- search
- git-revision-date-localized:
timezone: UTC # It can only be in UTC unless the ISO time can include timezone.
validation:
anchors: warn
watch: watch:
- mkdocs.template.yml - mkdocs.template.yml

View file

@ -62,6 +62,8 @@ markdown_extensions:
alternate_style: true alternate_style: true
plugins: plugins:
- search - search
- git-revision-date-localized:
timezone: UTC # It can only be in UTC unless the ISO time can include timezone.
- redirects: - redirects:
# Note that redirecting an anchor, e.g., `concepts/projects/#managing-dependencies` must be done # Note that redirecting an anchor, e.g., `concepts/projects/#managing-dependencies` must be done
# client-side and is implemented in `extra.js` instead. # client-side and is implemented in `extra.js` instead.
@ -164,3 +166,4 @@ validation:
omitted_files: warn omitted_files: warn
absolute_links: warn absolute_links: warn
unrecognized_links: warn unrecognized_links: warn
anchors: warn