Fix API doc and organize it #298
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 Generation | |
| on: [push, pull_request] | |
| jobs: | |
| DocBuild: | |
| 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: | | |
| bash ./.github/scripts/install_dependencies.sh | |
| pip install -r requirements_doc.txt | |
| - name: Build doc | |
| run: | | |
| mkdir -p build | |
| cd build | |
| cmake .. -DBUILD_DOC=ON | |
| make Sphinx | |
| MasterDocDeploy: | |
| runs-on: ubuntu-latest | |
| needs: [DocBuild] | |
| if: github.ref == 'refs/heads/main' | |
| 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: | | |
| bash ./.github/scripts/install_dependencies.sh | |
| pip install -r requirements_doc.txt | |
| - name: Build doc | |
| run: | | |
| mkdir -p build | |
| cd build | |
| cmake .. -DBUILD_DOC=ON | |
| make Sphinx | |
| cd .. | |
| - name: Publish doc | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./build/doc/sphinx | |
| destination_dir: master |