Skip to content

Commit b28e820

Browse files
committed
Build pdf docs too
1 parent 866cff1 commit b28e820

File tree

3 files changed

+36
-32
lines changed

3 files changed

+36
-32
lines changed

.github/workflows/doc-build-pdf.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,36 @@ jobs:
148148
with:
149149
name: doc-pdf
150150
path: doc-pdf.zip
151+
152+
#
153+
# On release events
154+
#
155+
156+
- name: Build live doc
157+
if: github.event_name != 'pull_request'
158+
run: |
159+
# Avoid running out of disk space
160+
rm -rf upstream
161+
export SAGE_USE_CDNS=yes
162+
export SAGE_LIVE_DOC=yes
163+
export SAGE_JUPYTER_SERVER=binder:sagemath/sage-binder-env/dev
164+
make doc-clean doc-uninstall
165+
./config.status && make sagemath_doc_html-no-deps
166+
shell: sh .github/workflows/docker-exec-script.sh BUILD /sage {0}
167+
168+
- name: Copy live doc
169+
if: github.event_name != 'pull_request'
170+
run: |
171+
mkdir -p ./livedoc
172+
# We copy everything to a local folder
173+
docker cp --follow-link BUILD:/sage/local/share/doc/sage/html livedoc
174+
docker cp --follow-link BUILD:/sage/local/share/doc/sage/pdf livedoc
175+
docker cp --follow-link BUILD:/sage/local/share/doc/sage/index.html livedoc
176+
zip -r livedoc.zip livedoc
177+
178+
- name: Upload live doc
179+
if: github.event_name != 'pull_request'
180+
uses: actions/upload-artifact@v4
181+
with:
182+
name: livedoc
183+
path: livedoc.zip

.github/workflows/doc-build.yml

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -204,32 +204,3 @@ jobs:
204204
with:
205205
name: doc-${{ github.ref_name }}
206206
path: doc.zip
207-
208-
- name: Build live doc
209-
if: github.event_name != 'pull_request'
210-
shell: bash -l {0}
211-
run: |
212-
# Remove previous doc build
213-
rm -rf builddir/src/doc
214-
meson compile -C builddir doc-html -j1
215-
env:
216-
SAGE_USE_CDNS: yes
217-
SAGE_LIVE_DOC: yes
218-
SAGE_JUPYTER_SERVER: binder:sagemath/sage-binder-env/dev
219-
220-
- name: Copy live doc
221-
if: github.event_name != 'pull_request'
222-
run: |
223-
mkdir -p ./livedoc
224-
# We copy everything to a local folder
225-
cp -r builddir/src/doc/html livedoc/
226-
cp builddir/src/doc/index.html livedoc/
227-
zip -r livedoc.zip livedoc
228-
229-
- name: Upload live doc
230-
if: github.event_name != 'pull_request'
231-
uses: actions/upload-artifact@v4
232-
with:
233-
name: livedoc
234-
path: livedoc.zip
235-

.github/workflows/doc-publish.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Publish documentation
22

33
on:
44
workflow_run:
5-
workflows: ["Build documentation"]
5+
workflows: ["Build documentation", "Build documentation (PDF)"]
66
types:
77
- completed
88

@@ -12,8 +12,8 @@ permissions:
1212
pull-requests: write
1313

1414

15-
# This workflow runs after doc-build workflow, taking the artifact
16-
# (doc/livedoc) and deploying it to a netlify site.
15+
# This workflow runs after doc-build and doc-build-pdf workflows, taking the
16+
# artifact (doc/livedoc) and deploying it to a netlify site.
1717
#
1818
# event (triggered doc-build) URL (of the doc deployed to NETLIFY_SITE)
1919
# --------------------------- ---------------------------------

0 commit comments

Comments
 (0)