Skip to content

add an action to deploy to github pages when pushed to master. #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Nov 14, 2020
Merged

add an action to deploy to github pages when pushed to master. #81

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d8e4abd
add an action to deploy to github pages when pushed to master.
tonyfast Nov 10, 2020
a1e51ac
create a draft of the sphinx docs before deploying to master
tonyfast Nov 10, 2020
0d6d5f8
build docs and deploy only on master
tonyfast Nov 10, 2020
5e8d245
CI: use requirements.txt to install dependencies in GH Actions
rgommers Nov 14, 2020
56824c6
Make sure to trigger on pull requests
rgommers Nov 14, 2020
cad1f1f
Fix Sphinx build and upload
rgommers Nov 14, 2020
d74e1f3
Fix the stage that only runs on PRs
rgommers Nov 14, 2020
52f7560
Get rid of doctrees in deployed html docs
rgommers Nov 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
on:
push:
branches:
- master
jobs:
run:
runs-on: ubuntu-18.04
steps:
# - uses: docker://pandoc/latex:2.9
- uses: actions/checkout@master
- uses: actions/setup-python@v2
with:
python-version: '3.8' # Version range or exact version of a Python version to use, using semvers version range syntax.
architecture: 'x64' # (x64 or x86)
- run: |
sudo apt install pandoc
# add dependencies based on the conf.py
pip install sphinx myst-parser sphinx-copybutton sphinx-markdown-tables
sphinx-build spec build
touch build/.nojekyll
- name: Build and Deploy
uses: JamesIves/github-pages-deploy-action@master
env:
ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BASE_BRANCH: master # The branch the action should deploy from.
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: build