-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
199cb91
commit ab3089d
Showing
2 changed files
with
184 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| name: Deploy MkDocs to GitHub Pages | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main # Adjust this to your main branch name | ||
| env: | ||
| PYTHON_VERSION: 3.x | ||
|
|
||
| permissions: | ||
| contents: write | ||
| id-token: write | ||
| pages: write | ||
|
|
||
|
|
||
| jobs: | ||
| documentation: | ||
| name: Build documentation | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| sparse-checkout: | | ||
| docs | ||
| # includes | ||
| # material/overrides | ||
| # src/templates/partials/languages | ||
| - name: Set up Python runtime | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ env.PYTHON_VERSION }} | ||
| cache: pip | ||
| cache-dependency-path: | | ||
| pyproject.toml | ||
| requirements.txt | ||
| - name: Set up build cache | ||
| uses: actions/cache/restore@v4 | ||
| with: | ||
| key: mkdocs-material-${{ hashfiles('.cache/**') }} | ||
| path: .cache | ||
| restore-keys: | | ||
| mkdocs-material- | ||
| - name: Install dependencies | ||
| run: sudo apt-get install pngquant | ||
|
|
||
| - name: Install Python dependencies | ||
| run: | | ||
| pip install mkdocs-material | ||
| pip install mkdocs-table-reader-plugin | ||
| # - name: Install Insiders build | ||
| # if: github.event.repository.fork == false | ||
| # env: | ||
| # GH_TOKEN: ${{ secrets.GH_TOKEN }} | ||
| # run: | | ||
| # # Warning: please don't use this method when installing Insiders from | ||
| # # CI! We have to do it this way in order to allow for overrides on our | ||
| # # own documentation, but you should stick to the method we recommend | ||
| # # in the publishing guide – see https://bit.ly/3zjdJtw | ||
| # git clone --depth 1 https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git | ||
| # pip install -e mkdocs-material-insiders | ||
| # cp mkdocs-material-insiders/mkdocs.yml mkdocs.yml | ||
| # # echo 'extra_javascript: [${{ vars.CHAT_CLIENT_URL }}]' >> mkdocs.yml | ||
| # rm -rf material | ||
| # cp -r mkdocs-material-insiders/material material | ||
|
|
||
| - name: Build documentation | ||
| # env: | ||
| # GH_TOKEN: ${{ secrets.GH_TOKEN }} | ||
| # GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }} | ||
| run: | | ||
| echo "Current directory: $(pwd)" | ||
| echo "Contents of current directory:" | ||
| ls -l | ||
| mkdocs build --clean | ||
| mkdocs --version | ||
| - name: Adjust permissions | ||
| run: | | ||
| chmod -c -R +rX site/ | while read line; do | ||
| echo "::warning title=Invalid file permissions automatically fixed::$line" | ||
| done | ||
| - name: Upload to GitHub Pages | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: site | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| uses: actions/deploy-pages@v4 | ||
|
|
||
| - name: Save build cache | ||
| uses: actions/cache/save@v4 | ||
| with: | ||
| key: mkdocs-material-${{ hashfiles('.cache/**') }} | ||
| path: .cache |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters