Skip to content

Commit 2667e29

Browse files
code4yongleicode4yonglei
authored
Initial commit
0 parents  commit 2667e29

17 files changed

+1092
-0
lines changed

‎.github/workflows/sphinx.yml

+170
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
# Deploy Sphinx. This could be shorter, but we also do some extra
2+
# stuff.
3+
#
4+
# License: CC-0. This is the canonical location of this file, which
5+
# you may want to link to anyway:
6+
# https://github.com/coderefinery/sphinx-lesson-template/blob/main/.github/workflows/sphinx.yml
7+
# https://raw.githubusercontent.com/coderefinery/sphinx-lesson-template/main/.github/workflows/sphinx.yml
8+
9+
10+
name: sphinx
11+
on: [push, pull_request]
12+
13+
env:
14+
DEFAULT_BRANCH: "main"
15+
# If these SPHINXOPTS are enabled, then be strict about the
16+
# builds and fail on any warnings.
17+
#SPHINXOPTS: "-W --keep-going -T"
18+
GENERATE_PDF: true # to enable, must be 'true' lowercase
19+
GENERATE_SINGLEHTML: true # to enable, must be 'true' lowercase
20+
PDF_FILENAME: lesson.pdf
21+
MULTIBRANCH: true # to enable, must be 'true' lowercase
22+
23+
24+
jobs:
25+
build:
26+
name: Build
27+
runs-on: ubuntu-latest
28+
permissions:
29+
contents: read
30+
31+
steps:
32+
# https://github.com/marketplace/actions/checkout
33+
- uses: actions/checkout@v4
34+
with:
35+
fetch-depth: 0
36+
lfs: true
37+
38+
# https://github.com/marketplace/actions/setup-python
39+
# ^-- This gives info on matrix testing.
40+
- name: Install Python
41+
uses: actions/setup-python@v4
42+
with:
43+
python-version: '3.11'
44+
cache: 'pip'
45+
46+
# https://docs.github.com/en/actions/guides/building-and-testing-python#installing-dependencies
47+
# ^-- This gives info on installing dependencies with pip
48+
- name: Install dependencies
49+
run: |
50+
python -m pip install --upgrade pip
51+
pip install -r requirements.txt
52+
53+
# Debug
54+
- name: Debugging information
55+
env:
56+
ref: ${{github.ref}}
57+
event_name: ${{github.event_name}}
58+
head_ref: ${{github.head_ref}}
59+
base_ref: ${{github.base_ref}}
60+
run: |
61+
echo "github.ref: ${ref}"
62+
echo "github.event_name: ${event_name}"
63+
echo "github.head_ref: ${head_ref}"
64+
echo "github.base_ref: ${base_ref}"
65+
echo "GENERATE_PDF: ${GENERATE_PDF}"
66+
echo "GENERATE_SINGLEHTML: ${GENERATE_SINGLEHTML}"
67+
set -x
68+
git rev-parse --abbrev-ref HEAD
69+
git branch
70+
git branch -a
71+
git remote -v
72+
python -V
73+
pip list --not-required
74+
pip list
75+
76+
77+
# Build
78+
- uses: ammaraskar/sphinx-problem-matcher@master
79+
- name: Build Sphinx docs (dirhtml)
80+
# SPHINXOPTS used via environment variables
81+
run: |
82+
make dirhtml
83+
# This fixes broken copy button icons, as explained in
84+
# https://github.com/coderefinery/sphinx-lesson/issues/50
85+
# https://github.com/executablebooks/sphinx-copybutton/issues/110
86+
# This can be removed once these PRs are accepted (but the
87+
# fixes also need to propagate to other themes):
88+
# https://github.com/sphinx-doc/sphinx/pull/8524
89+
# https://github.com/readthedocs/sphinx_rtd_theme/pull/1025
90+
sed -i 's/url_root="#"/url_root=""/' _build/dirhtml/index.html || true
91+
92+
# singlehtml
93+
- name: Generate singlehtml
94+
if: ${{ env.GENERATE_SINGLEHTML == 'true' }}
95+
run: |
96+
make singlehtml
97+
mv _build/singlehtml/ _build/dirhtml/singlehtml/
98+
99+
# PDF if requested
100+
- name: Generate PDF
101+
if: ${{ env.GENERATE_PDF == 'true' }}
102+
run: |
103+
pip install https://github.com/rkdarst/sphinx_pyppeteer_builder/archive/refs/heads/main.zip
104+
make pyppeteer
105+
mv _build/pyppeteer/*.pdf _build/dirhtml/${PDF_FILENAME}
106+
107+
# Stage all deployed assets in _gh-pages/ for simplicity, and to
108+
# prepare to do a multi-branch deployment.
109+
- name: Copy deployment data to _gh-pages/
110+
if: ${{ github.event_name == 'push' }}
111+
run:
112+
rsync -a _build/dirhtml/ _gh-pages/
113+
114+
# Use gh-pages-multibranch to multiplex different branches into
115+
# one deployment. See
116+
# https://github.com/coderefinery/gh-pages-multibranch
117+
- name: gh-pages multibranch
118+
uses: coderefinery/gh-pages-multibranch@main
119+
if: ${{ github.event_name == 'push' && env.MULTIBRANCH == 'true' }}
120+
with:
121+
directory: _gh-pages/
122+
default_branch: ${{ env.DEFAULT_BRANCH }}
123+
publish_branch: gh-pages
124+
125+
# Add the .nojekyll file
126+
- name: nojekyll
127+
if: ${{ github.event_name == 'push' }}
128+
run: |
129+
touch _gh-pages/.nojekyll
130+
131+
# Save artifact for the next step.
132+
- uses: actions/upload-artifact@v4
133+
if: ${{ github.event_name == 'push' }}
134+
with:
135+
name: gh-pages-build
136+
path: _gh-pages/
137+
138+
# Deploy in a separate job so that write permissions are restricted
139+
# to the minimum steps.
140+
deploy:
141+
name: Deploy
142+
runs-on: ubuntu-latest
143+
needs: build
144+
# This if can't use the env context - find better way later.
145+
if: ${{ github.event_name == 'push' }}
146+
permissions:
147+
contents: write
148+
149+
steps:
150+
- uses: actions/download-artifact@v4
151+
if: ${{ github.event_name == 'push' && ( env.MULTIBRANCH == 'true' || github.ref == format('refs/heads/{0}', env.DEFAULT_BRANCH )) }}
152+
with:
153+
name: gh-pages-build
154+
path: _gh-pages/
155+
156+
# As of 2023, we could publish to pages via a Deployment. This
157+
# isn't done yet to give it time to stabilize (out of beta), and
158+
# also having a gh-pages branch to check out is rather
159+
# convenient.
160+
161+
# Deploy
162+
# https://github.com/peaceiris/actions-gh-pages
163+
- name: Deploy
164+
uses: peaceiris/actions-gh-pages@v3
165+
if: ${{ github.event_name == 'push' && ( env.MULTIBRANCH == 'true' || github.ref == format('refs/heads/{0}', env.DEFAULT_BRANCH )) }}
166+
with:
167+
publish_branch: gh-pages
168+
github_token: ${{ secrets.GITHUB_TOKEN }}
169+
publish_dir: _gh-pages/
170+
force_orphan: true

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/_build
2+
.ipynb_checkpoints
3+
/venv*
4+
.jupyter_cache
5+
jupyter_execute

0 commit comments

Comments
 (0)