feat(docs): add docstrings for scene and entity #16
This file contains hidden or 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 and Deploy Documentation | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repository | |
| uses: actions/checkout@v3 | |
| - name: Install Dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y doxygen graphviz | |
| python -m pip install --upgrade pip | |
| pip install -r docs/requirements.txt | |
| - name: Generate Doxygen XML | |
| run: | | |
| rm -rf build/doxygen | |
| mkdir -p build/doxygen | |
| doxygen Doxyfile | |
| - name: Build Sphinx Documentation | |
| run: | | |
| sphinx-build -b html docs/ build/sphinx/html | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./build/sphinx/html |