Generate class diagrams in docs CI #7
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: deploy-pages | |
on: | |
push: | |
# branches: | |
# - develop | |
paths: | |
- docs/** | |
# This job installs dependencies, builds the book, and pushes it to `gh-pages` | |
jobs: | |
deploy-book: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
# Install dependencies | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
- name: Install dependencies | |
run: | | |
pip install -e ".[docs]" | |
pip install pylint | |
# Generate any required diagrams | |
- name: Make diagrams | |
working-directory: ${{runner.workspace}}/wcomp/wcomp | |
run: | | |
pyreverse base_interface.py -c WCompBase -o mmd | |
# Build the book | |
- name: Build the book | |
working-directory: ${{runner.workspace}}/wcomp/docs/ | |
run: | | |
jupyter-book build . | |
# Push the book's HTML to github-pages | |
- name: GitHub Pages action | |
uses: peaceiris/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/_build/html |