trying to fix the docs in CI #352
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: Create Documentation | |
on: | |
push: | |
branches: | |
- develop | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: 3.12 | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
# Install the required dependencies | |
- name: Install Dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install myst-parser sphinx-rtd-theme | |
pip install -r requirements.txt | |
# Install your package to ensure autodoc works | |
- name: Install ms_mint package | |
run: pip install -e . | |
# Build the Sphinx documentation | |
- name: Build Documentation | |
run: | | |
sphinx-build -b html docs/ docs/_build/html -W -v | |
# Deploy the built documentation to the gh-pages branch | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html # Ensure this path matches your build output |