Skip to content

Merge pull request #378 from monarch-initiative/ielis/issue373 #178

Merge pull request #378 from monarch-initiative/ielis/issue373

Merge pull request #378 from monarch-initiative/ielis/issue373 #178

Workflow file for this run

name: Deploy documentation to GitHub Pages
on:
workflow_dispatch:
push:
branches: [ main, develop ]
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install library with docs dependencies
run: |
python3 -m pip install .[docs]
- name: Generate examples and build documentation
run: |
## Init the target folder.
# We will put all site documentation there.
mkdir -p gh-pages
touch gh-pages/.nojekyll
function build_docs {
# The function will checkout a branch and build the API docs & documentation
# into provided directory.
BRANCH=${1}
DOCDIR=${2}
git checkout ${BRANCH}
git fetch
git pull
## Init the target folder.
# We will put all site documentation there.
mkdir -p gh-pages/${DOCDIR}
## Build the docs
# Generate the HTML pages and move the generated content into the target folder.
printf "Building the %s documentation\n" ${DOCDIR}
cd docs
sphinx-apidoc --separate --module-first -d 2 -H "API reference" --follow-links -o apidocs ../src/gpsea
make clean html
mv _build/html/* ../gh-pages/${DOCDIR}
cd ..
}
# We store the docs for `main` in `stable` dir
build_docs main stable
# We store the docs for `development` in `latest` dir
build_docs develop latest
- name: Deploy documentation
if: ${{ github.event_name == 'push' }}
uses: JamesIves/github-pages-deploy-action@v4.4.1
with:
branch: gh-pages
force: true
folder: gh-pages