Skip to content

Tidy up the use of interpolation #1730

Tidy up the use of interpolation

Tidy up the use of interpolation #1730

Workflow file for this run

name: "Build and publish documentation"
on:
pull_request:
types: [opened, synchronize, reopened]
push:
branches: ["main"]
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.13
- name: Install dependencies
run: |
sudo apt update -y
sudo apt install -y pandoc graphviz latexmk texlive-latex-recommended \
texlive-latex-extra texlive-fonts-recommended
python -m pip install -e .[doc,dev]
- name: Generate results for default model
run: |
muse --model default
# Create a symlink in the docs folder as running-muse-example.ipynb assumes
# they will be there
ln -s ../Results docs/
- name: Test notebooks and tutorials
run: pytest -m "notebook"
- name: Build HTML documentation
run: python -m sphinx -b html docs docs/build/html
- name: Build PDF documentation
run: |
python -m sphinx -b latex docs docs/build/latex
cd docs/build/latex
latexmk -interaction=nonstopmode -pdf muse
- name: Upload HTML
uses: actions/upload-artifact@v4
with:
name: DocumentationHTML
path: docs/build/html
- name: Upload PDF
uses: actions/upload-artifact@v4
with:
name: DocumentationPDF
path: docs/build/latex/muse.pdf
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/master'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html