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 :
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
@@ -49,32 +52,28 @@ jobs:
4952 uses : actions/setup-python@v5
5053 with :
5154 python-version : " 3.11"
52- - uses : actions/cache@v3
55+ - uses : actions/cache@v4
5356 id : cache
5457 with :
5558 path : ${{ env.pythonLocation }}
56- key : ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v02
59+ key : ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt' ) }}-v02
5760 - name : Install docs extras
5861 if : steps.cache.outputs.cache-hit != 'true'
5962 run : pip install -r requirements-docs.txt
6063 - name : Install Material for MkDocs Insiders
6164 if : ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
62- run : |
63- pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
64- pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
65- pip install git+https://${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
66- - uses : actions/cache@v3
65+ run : pip install -r requirements-docs-insiders.txt
66+ env :
67+ TOKEN : ${{ secrets.TYPER_MKDOCS_MATERIAL_INSIDERS }}
68+ - uses : actions/cache@v4
6769 with :
6870 key : mkdocs-cards-${{ github.ref }}-v1
6971 path : .cache
72+ - name : Verify README
73+ run : python ./scripts/docs.py verify-readme
7074 - name : Build Docs
71- if : github.event_name == 'pull_request' && github.secret_source != 'Actions'
72- run : python -m mkdocs build
73- - name : Build Docs with Insiders
74- if : ( github.event_name != 'pull_request' || github.secret_source == 'Actions' )
75- run : python -m mkdocs build --config-file mkdocs.insiders.yml
76-
77- - uses : actions/upload-artifact@v3
75+ run : python ./scripts/docs.py build
76+ - uses : actions/upload-artifact@v4
7877 with :
7978 name : docs-site
8079 path : ./site/**
0 commit comments