fix(docs): install requirements CORRECTLY in CI (#224) #206
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
# cspell: ignore nojekyll | |
name: documentation | |
on: | |
push: | |
branches: | |
- develop | |
- main | |
pull_request: | |
types: [closed] | |
permissions: | |
contents: write | |
id-token: write | |
pages: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
if: github.event_name == 'push' || github.event.pull_request.merged == true | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/cache@v4 | |
with: | |
key: ${{ github.ref }} | |
path: .cache | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- run: | | |
sudo apt update && sudo apt install -y doxygen && \ | |
pip install mkdocs \ | |
mkdocs-material \ | |
Jinja2 \ | |
ruamel.yaml && \ | |
pip install git+https://github.com/JakubAndrysek/mkdoxy && \ | |
pip install -r docs/requirements.txt | |
- run: mkdocs build --site-dir _site | |
- run: touch _site/.nojekyll | |
- run: | | |
chmod -c -R +rX "_site/" | while read line; do | |
echo "::warning title=Invalid file permissions automatically fixed::$line" | |
done | |
- uses: actions/upload-pages-artifact@v3 | |
- uses: actions/deploy-pages@v4 |