Add Sphinx doc #447
Workflow file for this run
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: Documentation | |
| on: [push, pull_request] | |
| jobs: | |
| BuildDocs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python 3.7 | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: 3.7 | |
| - name: Install dependencies | |
| run: | | |
| sudo apt install -y python3-numpy | |
| pip install -r CI/doc/requirements_doc.txt | |
| - name: Check doc build | |
| run: | | |
| make -C CI/doc gen_hdl_refdesigns html | |
| - name: Publish master doc | |
| if: github.ref == 'refs/heads/master' | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./doc | |
| destination_dir: master |