Add more documentations (#71) #33
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: Generate doc | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - doc | |
| concurrency: | |
| group: build-doc-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-doc: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| python-version: [3.8] | |
| steps: | |
| # refer to https://github.com/actions/checkout | |
| - uses: actions/checkout@v2 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Display Python version | |
| run: python -c "import sys; print(sys.version)" | |
| - name: Build doc | |
| shell: bash | |
| run: | | |
| python3 -m pip install numpy | |
| mkdir build | |
| cd build | |
| cmake .. | |
| make -j | |
| cd ../docs | |
| python3 -m pip install -r ./requirements.txt | |
| make html | |
| touch build/html/.nojekyll | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build/html | |
| publish_branch: gh-pages |