Update python script docs #179
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: Docs | |
| on: | |
| push: | |
| branches: [main] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Requirements | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install doxygen sphinx-doc cmake pipx python3-sphinx-rtd-theme python3-breathe libboost-iostreams1.74-dev libtbb-dev | |
| pipx install black git+https://github.com/5had3z/pybind11-stubgen.git | |
| pip3 install torch --index-url https://download.pytorch.org/whl/cpu --break-system-packages | |
| pip3 install typer matplotlib opencv-python-headless mpyq --break-system-packages | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Build main library for python bindings | |
| run: pip3 install . --break-system-packages | |
| - name: Build docs | |
| run: | | |
| make -C docs html | |
| touch docs/_build/html/.nojekyll | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@releases/v3 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages # The branch the action should deploy to. | |
| FOLDER: docs/_build/html # The folder the action should deploy. |