Documentation #97
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: | |
| workflow_dispatch: ~ | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Setup Python | |
| uses: actions/setup-python@v4.2.0 | |
| with: | |
| python-version: "3.10" | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get install -y sed jq git | |
| pip install --upgrade sphinx_rtd_theme sphinx docutils sphinx-sitemap sphinxcontrib-spelling sphinx-tabs sphinxcontrib-youtube pygments breathe sphinx-copybutton | |
| - uses: actions/checkout@v3 | |
| with: | |
| path: current_repo | |
| - name: Build doc | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: current_repo/docs/build.sh | |
| shell: bash | |
| - name: Upload documetation to gh-pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: ./gh-pages | |
| - name: Upload artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: DocumentationHTML | |
| path: gh-pages |