18
18
docs : ${{ steps.filter.outputs.docs }}
19
19
steps :
20
20
- 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
22
22
- uses : dorny/paths-filter@v3
23
23
id : filter
24
24
with :
28
28
- docs/**
29
29
- docs_src/**
30
30
- requirements-docs.txt
31
+ - requirements-docs-insiders.txt
31
32
- pyproject.toml
32
33
- mkdocs.yml
33
34
- mkdocs.insiders.yml
35
+ - mkdocs.maybe-insiders.yml
36
+ - mkdocs.no-insiders.yml
34
37
- .github/workflows/build-docs.yml
35
38
- .github/workflows/deploy-docs.yml
36
39
langs :
@@ -49,17 +52,16 @@ jobs:
49
52
id : cache
50
53
with :
51
54
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
53
56
- name : Install docs extras
54
57
if : steps.cache.outputs.cache-hit != 'true'
55
58
run : pip install -r requirements-docs.txt
56
59
# Install MkDocs Material Insiders here just to put it in the cache for the rest of the steps
57
60
- name : Install Material for MkDocs Insiders
58
61
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 }}
63
65
- name : Verify Docs
64
66
run : python ./scripts/docs.py verify-docs
65
67
- name : Export Language Codes
@@ -90,16 +92,15 @@ jobs:
90
92
id : cache
91
93
with :
92
94
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
94
96
- name : Install docs extras
95
97
if : steps.cache.outputs.cache-hit != 'true'
96
98
run : pip install -r requirements-docs.txt
97
99
- name : Install Material for MkDocs Insiders
98
100
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 }}
103
104
- name : Update Languages
104
105
run : python ./scripts/docs.py update-languages
105
106
- uses : actions/cache@v4
0 commit comments