Skip to content

Commit

Permalink
MAINT: Enable gh-pages and disable latex, and download notebooks (#29)
Browse files Browse the repository at this point in the history
* remove latexpdf and download notebooks builds

* enable building to gh-pages

* update root url

* fix isssue
  • Loading branch information
mmcky authored Sep 18, 2024
1 parent 4568765 commit 170c088
Show file tree
Hide file tree
Showing 3 changed files with 135 additions and 21 deletions.
40 changes: 20 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,32 +44,32 @@ jobs:
branch: main
name: build-cache
path: _build
# Build Assets (Download Notebooks and PDF via LaTeX)
- name: Build PDF from LaTeX
shell: bash -l {0}
run: |
jb build lectures --builder pdflatex --path-output ./ -n --keep-going
mkdir -p _build/html/_pdf
cp -u _build/latex/*.pdf _build/html/_pdf
- name: Upload Execution Reports (LaTeX)
uses: actions/upload-artifact@v4
if: failure()
with:
name: execution-reports
path: _build/latex/reports
- name: Build Download Notebooks (sphinx-tojupyter)
shell: bash -l {0}
run: |
jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter
mkdir -p _build/html/_notebooks
cp -u _build/jupyter/*.ipynb _build/html/_notebooks
# # Build Assets (Download Notebooks and PDF via LaTeX)
# - name: Build PDF from LaTeX
# shell: bash -l {0}
# run: |
# jb build lectures --builder pdflatex --path-output ./ -n --keep-going
# mkdir -p _build/html/_pdf
# cp -u _build/latex/*.pdf _build/html/_pdf
# - name: Upload Execution Reports (LaTeX)
# uses: actions/upload-artifact@v4
# if: failure()
# with:
# name: execution-reports
# path: _build/latex/reports
# - name: Build Download Notebooks (sphinx-tojupyter)
# shell: bash -l {0}
# run: |
# jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter
# mkdir -p _build/html/_notebooks
# cp -u _build/jupyter/*.ipynb _build/html/_notebooks
# Build HTML (Website)
# BUG: rm .doctress to remove `sphinx` rendering issues for ipywidget mimetypes
# and clear the sphinx cache for building final HTML documents.
# rm -r _build/.doctrees
- name: Build HTML
shell: bash -l {0}
run: |
rm -r _build/.doctrees
jb build lectures --path-output ./ -nW --keep-going
- name: Upload Execution Reports (HTML)
uses: actions/upload-artifact@v4
Expand Down
114 changes: 114 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
name: Build & Publish to GH-PAGES
on:
push:
tags:
- 'publish*'
jobs:
publish:
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Anaconda
uses: conda-incubator/setup-miniconda@v3
with:
auto-update-conda: true
auto-activate-base: true
miniconda-version: 'latest'
python-version: "3.11"
environment-file: environment.yml
activate-environment: quantecon
- name: Install latex dependencies
run: |
sudo apt-get -qq update
sudo apt-get install -y \
texlive-latex-recommended \
texlive-latex-extra \
texlive-fonts-recommended \
texlive-fonts-extra \
texlive-xetex \
latexmk \
xindy \
dvipng \
cm-super
- name: Display Conda Environment Versions
shell: bash -l {0}
run: conda list
- name: Display Pip Versions
shell: bash -l {0}
run: pip list
- name: Download "build" folder (cache)
uses: dawidd6/action-download-artifact@v6
with:
workflow: cache.yml
branch: main
name: build-cache
path: _build
# # Build Assets (Download Notebooks and PDF via LaTeX)
# - name: Build PDF from LaTeX
# shell: bash -l {0}
# run: |
# jb build lectures --builder pdflatex --path-output ./ -n --keep-going
# - name: Copy LaTeX PDF for GH-PAGES
# shell: bash -l {0}
# run: |
# mkdir -p _build/html/_pdf
# cp -u _build/latex/*.pdf _build/html/_pdf
# - name: Build Download Notebooks (sphinx-tojupyter)
# shell: bash -l {0}
# run: |
# jb build lectures --path-output ./ --builder=custom --custom-builder=jupyter
# - name: Copy Download Notebooks for GH-PAGES
# shell: bash -l {0}
# run: |
# mkdir -p _build/html/_notebooks
# cp -u _build/jupyter/*.ipynb _build/html/_notebooks
# Build HTML (Website)
# BUG: rm .doctress to remove `sphinx` rendering issues for ipywidget mimetypes
# and clear the sphinx cache for building final HTML documents.
# # rm -r _build/.doctrees
- name: Build HTML
shell: bash -l {0}
run: |
jb build lectures --path-output ./
- name: Deploy to Netlify
uses: nwtgck/[email protected]
with:
publish-dir: '_build/html/'
production-branch: main
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: "Deploy from GitHub Actions"
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
- name: Deploy website to gh-pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/html/
# cname: intro-cn.quantecon.org
- name: Upload "_build" folder (publish)
uses: actions/upload-artifact@v4
with:
name: build-publish
path: _build
# # Sync notebooks
# - name: Prepare lecture-python-intro.notebooks sync
# shell: bash -l {0}
# run: |
# mkdir -p _build/lecture-python-intro.notebooks
# cp -a _notebook_repo/. _build/lecture-python-intro.notebooks
# cp _build/jupyter/*.ipynb _build/lecture-python-intro.notebooks
# ls -a _build/lecture-python-intro.notebooks
# - name: Commit latest notebooks to lecture-python-intro.notebooks
# uses: cpina/github-action-push-to-another-repository@main
# env:
# API_TOKEN_GITHUB: ${{ secrets.QUANTECON_SERVICES_PAT }}
# with:
# source-directory: '_build/lecture-python-intro.notebooks/'
# destination-repository-username: 'QuantEcon'
# destination-repository-name: 'lecture-python-intro.notebooks'
# commit-message: 'auto publishing updates to notebooks'
# destination-github-username: 'quantecon-services'
# user-email: [email protected]
2 changes: 1 addition & 1 deletion lectures/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ execute:
- '_static/*'

html:
baseurl: https://intro.quantecon.org/
baseurl: https://intro-cn.quantecon.org/

bibtex_bibfiles:
- _static/quant-econ.bib
Expand Down

1 comment on commit 170c088

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.