Merge pull request #45 from TheJacksonLaboratory/improve-docs #16
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Simple workflow for deploying static content to GitHub Pages | |
| name: Deploy documentation to GitHub Pages | |
| on: | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Runs on pushes targeting the main branch | |
| push: | |
| branches: [ main, development ] | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 # otherwise, you will fail to push refs to dest repo | |
| ref: main | |
| - name: Set up Python 3 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: 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 `BRANCH` and build the documentation | |
| # into the provided documentation directory `DOCDIR`. | |
| BRANCH=${1} | |
| DOCDIR=${2} | |
| git checkout ${BRANCH} | |
| git fetch | |
| git pull | |
| python3 -m pip install .[docs] | |
| ## 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/hpotk | |
| make clean html | |
| mv _build/html/* ../gh-pages/${DOCDIR} | |
| cd .. | |
| } | |
| # We store the docs for `main` in `stable` dir | |
| # TODO - re-enable before deploying a version. | |
| #build_docs main stable | |
| # We store the docs for `development` in `latest` dir | |
| build_docs development 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 |