Skip to content

Commit 9fbfc05

Browse files
committed
Update URL. Update build instructions and use theme from package
1 parent ffcd894 commit 9fbfc05

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Build & Deploy Docs (github.io)
2+
# Written by GPT
3+
4+
on:
5+
# Re-publish the site when we trigger the job from the Actions tab.
6+
workflow_dispatch: {}
7+
8+
jobs:
9+
build-docs:
10+
runs-on: ubuntu-latest
11+
12+
# Needed so we can push to gh-pages
13+
permissions:
14+
contents: write
15+
16+
steps:
17+
# 1 — Source code
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
with:
21+
fetch-depth: 0 # so we can create/update gh-pages
22+
23+
# 2 — System packages only: Python-Sphinx + minimal TeX
24+
- name: Install Debian Sphinx and TeX tool-chain
25+
run: |
26+
sudo apt-get update
27+
sudo apt-get install -y --no-install-recommends \
28+
python3-sphinx \
29+
python3-sphinx-rtd-theme \
30+
latexmk \
31+
texlive-latex-recommended \
32+
texlive-latex-extra
33+
# `python3-sphinx` pulls in docutils, jinja2, pygments, babel, etc.
34+
35+
# 3 — Build HTML & PDF (commands straight from the README)
36+
- name: Build HTML and PDF
37+
run: |
38+
make html
39+
make latexpdf
40+
# publish the PDF with the site
41+
cp build/latex/*.pdf build/html/
42+
43+
# 4 — Deploy to gh-pages
44+
- name: Deploy to gh-pages
45+
uses: peaceiris/actions-gh-pages@v4
46+
with:
47+
github_token: ${{ secrets.GITHUB_TOKEN }}
48+
publish_branch: gh-pages
49+
publish_dir: build/html

0 commit comments

Comments
 (0)