Skip to content

Commit 0cd844d

Browse files
authored
🔧 Update docs setup with latest configs and plugins (fastapi#11953)
1 parent af1a070 commit 0cd844d

File tree

643 files changed

+37192
-21693
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

643 files changed

+37192
-21693
lines changed

.github/workflows/build-docs.yml

+12-11
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
docs: ${{ steps.filter.outputs.docs }}
1919
steps:
2020
- uses: actions/checkout@v4
21-
# For pull requests it's not necessary to checkout the code but for master it is
21+
# For pull requests it's not necessary to checkout the code but for the main branch it is
2222
- uses: dorny/paths-filter@v3
2323
id: filter
2424
with:
@@ -28,9 +28,12 @@ jobs:
2828
- docs/**
2929
- docs_src/**
3030
- requirements-docs.txt
31+
- requirements-docs-insiders.txt
3132
- pyproject.toml
3233
- mkdocs.yml
3334
- mkdocs.insiders.yml
35+
- mkdocs.maybe-insiders.yml
36+
- mkdocs.no-insiders.yml
3437
- .github/workflows/build-docs.yml
3538
- .github/workflows/deploy-docs.yml
3639
langs:
@@ -49,17 +52,16 @@ jobs:
4952
id: cache
5053
with:
5154
path: ${{ env.pythonLocation }}
52-
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-tests.txt') }}-v07
55+
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v08
5356
- name: Install docs extras
5457
if: steps.cache.outputs.cache-hit != 'true'
5558
run: pip install -r requirements-docs.txt
5659
# Install MkDocs Material Insiders here just to put it in the cache for the rest of the steps
5760
- name: Install Material for MkDocs Insiders
5861
if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
59-
run: |
60-
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
61-
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
62-
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
62+
run: pip install -r requirements-docs-insiders.txt
63+
env:
64+
TOKEN: ${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}
6365
- name: Verify Docs
6466
run: python ./scripts/docs.py verify-docs
6567
- name: Export Language Codes
@@ -90,16 +92,15 @@ jobs:
9092
id: cache
9193
with:
9294
path: ${{ env.pythonLocation }}
93-
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-tests.txt') }}-v08
95+
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v08
9496
- name: Install docs extras
9597
if: steps.cache.outputs.cache-hit != 'true'
9698
run: pip install -r requirements-docs.txt
9799
- name: Install Material for MkDocs Insiders
98100
if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
99-
run: |
100-
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
101-
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
102-
pip install git+https://${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
101+
run: pip install -r requirements-docs-insiders.txt
102+
env:
103+
TOKEN: ${{ secrets.FASTAPI_MKDOCS_MATERIAL_INSIDERS }}
103104
- name: Update Languages
104105
run: python ./scripts/docs.py update-languages
105106
- uses: actions/cache@v4

0 commit comments

Comments
 (0)