fix docs #3
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: doc | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: '*' | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Install LaTeX for math support | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install texlive | |
| - name: generate doc | |
| run: | | |
| pip install -r requirements.txt | |
| pip install -r doc/requirements.txt | |
| cd doc/ | |
| make html | |
| make linkcheck | |
| make doctest | |
| - name: Deploy doc | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./doc/_build/html | |