Workflow file for this run
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: Build Python API and Deploy Sphinx Docs to GitHub Pages | |
| on: | |
| push: | |
| # Trigger the workflow when changes are pushed to the 'main' branch | |
| branches: | |
| - direct_sphinx | |
| # Only run on changes to files relevant to the documentation | |
| paths: | |
| - '**.rst' | |
| - '**.md' | |
| - '**.py' | |
| - 'python/python_direct/**' | |
| jobs: | |
| build_and_deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| with: | |
| submodules: true | |
| uses: actions/checkout@v4 | |
| - name: Set up Python 🐍 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' | |
| - name: Install dependencies 📦 | |
| # You may need to adjust this depending on where your Sphinx requirements are | |
| run: | | |
| python -m pip install --upgrade pip | |
| # Install Sphinx and any other required packages (like 'furo', 'myst-parser', etc.) | |
| pip install sphinx sphinx_toolbox sphinx-rtd-theme myst-parser | |
| - name: Build | |
| working-directory: ${{ env.working_directory }} | |
| run: | | |
| tools/apt-install-things.sh & | |
| tools/pip-install-things.sh & | |
| wait | |
| source tools/setup-env.sh | |
| cd python | |
| python setup.py build --no-cutlass --no-test --no-benchmark --no-ninja | |
| - name: Build documentation 🏗️ | |
| run: | | |
| # Change directory to where your conf.py and source files are | |
| # Usually, this is the 'docs' folder | |
| cd ../doc/sphinx | |
| make html | |
| touch build/html/.nojekyll | |
| - name: Deploy to GitHub Pages 🚀 | |
| uses: peaceiris/actions-gh-pages@v4 | |
| if: github.ref == 'refs/heads/direct_sphinx' # Only deploy if the push is to the main branch | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # The folder containing the generated HTML files | |
| publish_dir: doc/sphinx/build/html | |
| # Use the dedicated gh-pages branch for deployment | |
| publish_branch: gh-pages | |
| # KEY ADDITION: Publish the content inside a 'docs' subfolder on the 'gh-pages' branch | |
| destination_dir: docs |