Skip to content

Merge pull request #584 from Ecogenomics/staging #63

Merge pull request #584 from Ecogenomics/staging

Merge pull request #584 from Ecogenomics/staging #63

Workflow file for this run

# This workflow automatically generates the Sphinx documentation required for
# GitHub pages. Executed when master is pushed to.
name: Documentation update
on:
push:
branches: master
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v2
with:
python-version: '3.8'
# Checkout the master branch (docs will be built from this)
- uses: actions/checkout@v2
with:
path: master
# Checkout the documentation branch (docs will be pushed to this)
- uses: actions/checkout@v2
with:
ref: gh_pages
path: gh_pages
- name: Install Sphinx requirements
working-directory: ${{ github.workspace }}/master/docs
run: |
sudo apt-get update -y
sudo apt-get install -y pandoc
python -m pip install --upgrade pip
python -m pip install -r requirements.txt
- name: Build documentation
working-directory: ${{ github.workspace }}/master/docs
run: make html
- name: Move documentation
run: |
touch master/docs/build/html/.nojekyll
cp -a master/docs/build/html/. gh_pages/
- name: Upload documentation
working-directory: ${{ github.workspace }}/gh_pages
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add --all
git diff-index --quiet HEAD || git commit -m "docs update" -a
git push