[fix] doc generation on github #65
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
name: publish documentation | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
docs_to_gh-pages: | |
runs-on: ubuntu-latest | |
name: publish documentation | |
steps: | |
- uses: actions/checkout@v2 | |
with: | |
submodules: recursive | |
- name: Setup Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: '3.8' | |
- name: install dependencies pip | |
run: | | |
python3 -m pip install -U pip | |
bash scripts/install.sh --cpu | |
python3 -m pip install .[doc] | |
- name: make docs | |
run: | | |
make -C docs clean | |
make -C docs html | |
- name: Init repo for generated files | |
run: | | |
cd docs/_build/html | |
git init | |
touch .nojekyll | |
git add --all | |
git config --local user.email "[email protected]" | |
git config --local user.name "CompressAI" | |
git commit -m "deploy" | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
if: github.ref == 'refs/heads/main' | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html |