maxplotlib/.github/workflows/docs.yml at devel · max-models/maxplotlib · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
name: Docs

# The Astro + Starlight site in docs/: hand-written pages, the executed tutorials and the API
# reference. Built on every push and pull request with the shared workflow of
# max-models/starlight-theme; deployed to GitHub Pages from devel.
# The TikZ tutorials compile their figures with pdflatex and pgfplots, hence the LaTeX packages.

on:
  push:
    branches: ["main", "devel"]
  pull_request:
    branches: ["main", "devel"]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  docs:
    uses: max-models/starlight-theme/.github/workflows/docs.yml@v0
    with:
      apt-packages: "texlive-latex-base texlive-latex-extra texlive-pictures texlive-fonts-recommended lmodern"
      # the example web figures of guides/web-figures, from scripts/web_figure_examples.py
      pre-build: '"$DOCS_PYTHON" scripts/web_figure_examples.py'
      # stable-branch: main  # deploy the latest release at /<repo>/ and devel at /<repo>/dev/
      # a notebook's outputs are numbered in order: in tutorial 07, 1.html is the Plotly
      # preview and 2.png the first compiled TikZ figure
      smoke-paths: |
        getting-started/installation/index.html
        getting-started/quickstart/index.html
        guides/matplotlib-import/index.html
        guides/web-figures/index.html
        figures/waves.plotly.json
        figures/heatmap.plotly.json
        figures/packet.plotly.json
        tutorials/index.html
        tutorials/tutorial-01/index.html
        tutorials/tutorial-07-tikz/index.html
        tutorials/tutorial-17-xarray/index.html
        tutorials/tutorial-07-tikz/2.png
        tutorials/tutorial-01/tutorial_01.ipynb
        api/maxplotlib/index.html
        api/maxplotlib/canvas/index.html