New documentation. #17
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: | |
| branches: | |
| - main | |
| permissions: | |
| contents: write | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v3 | |
| - name: Install dependencies | |
| run: | | |
| pip install sphinx sphinx_rtd_theme sphinx-copybutton | |
| sudo apt-get install doxygen | |
| sudo apt -y install graphviz | |
| - name: Sphinx and Doxygen build | |
| run: | | |
| make -C docs clean | |
| make -C docs html | |
| cd docs | |
| doxygen Doxyfile | |
| cd .. | |
| mkdir docs/build/html/doxygen | |
| cp -r docs/html/* docs/build/html/doxygen/ | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/build/html | |
| force_orphan: true |