Simplify API documentation: remove Sphinx autosummary, use plain mark… #25
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 and Deploy Documentation | |
| on: | |
| push: | |
| branches: [main, indev] | |
| paths: | |
| - '.github/workflows/docs.yml' | |
| - 'diive/**' | |
| - 'notebooks/**' | |
| - 'docs/**' | |
| - 'pyproject.toml' | |
| - 'poetry.lock' | |
| pull_request: | |
| branches: [main, indev] | |
| paths: | |
| - '.github/workflows/docs.yml' | |
| - 'diive/**' | |
| - 'notebooks/**' | |
| - 'docs/**' | |
| - 'pyproject.toml' | |
| - 'poetry.lock' | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install poetry | |
| pip install jupyter-book ghp-import | |
| - name: Install project | |
| run: | | |
| poetry install --only main | |
| - name: Build documentation | |
| run: | | |
| poetry run jupyter-book clean -a docs/source | |
| poetry run jupyter-book build docs/source | |
| - name: Deploy to GitHub Pages | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| run: | | |
| poetry run ghp-import -n -p -f docs/source/_build/html |