Skip to content

Commit

Permalink
Move content from the mkdocs.public.yml into the template (#11246)
Browse files Browse the repository at this point in the history
Closes #11242
  • Loading branch information
zanieb authored Feb 5, 2025
1 parent acbbb2b commit 1f963d1
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,8 @@ jobs:
MKDOCS_INSIDERS_SSH_KEY_EXISTS: ${{ secrets.MKDOCS_INSIDERS_SSH_KEY != '' }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: astral-sh/setup-uv@v5
- uses: actions/setup-python@v5
- name: "Add SSH key"
Expand Down
15 changes: 14 additions & 1 deletion docs/requirements-insiders.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# 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-material
# via
# mkdocs-git-revision-date-localized-plugin
# mkdocs-material
black==23.10.0
# via -r docs/requirements.in
certifi==2024.7.4
Expand All @@ -19,6 +21,10 @@ colorama==0.4.6
# 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
Expand Down Expand Up @@ -71,8 +77,11 @@ mergedeep==1.3.4
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-material @ git+ssh://[email protected]/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4
# via
# -r docs/requirements-insiders.in
Expand Down Expand Up @@ -105,6 +114,8 @@ 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
Expand All @@ -118,6 +129,8 @@ requests==2.32.3
# via mkdocs-material
six==1.16.0
# via python-dateutil
smmap==5.0.2
# via gitdb
uc-micro-py==1.0.3
# via linkify-it-py
urllib3==2.2.2
Expand Down
10 changes: 3 additions & 7 deletions mkdocs.public.yml
Original file line number Diff line number Diff line change
@@ -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
# 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:
- mkdocs.template.yml
3 changes: 3 additions & 0 deletions mkdocs.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ markdown_extensions:
alternate_style: true
plugins:
- search
- git-revision-date-localized:
timezone: UTC # It can only be in UTC unless the ISO time can include timezone.
- redirects:
# Note that redirecting an anchor, e.g., `concepts/projects/#managing-dependencies` must be done
# client-side and is implemented in `extra.js` instead.
Expand Down Expand Up @@ -164,3 +166,4 @@ validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn

0 comments on commit 1f963d1

Please sign in to comment.