Add documentation for substitution models #4
Workflow file for this run
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
name: Publish the documentation on a branch | |
on: | |
push: | |
branches: | |
- improve-documentation | |
jobs: | |
publish: | |
name: Publish | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout the branch | |
uses: actions/[email protected] | |
with: | |
persist-credentials: false | |
- name: Set up Python 3.9 | |
uses: actions/setup-python@v1 | |
with: | |
python-version: 3.9 | |
- name: Build the documentation with Sphinx | |
run: | | |
pip install -r docs/requirements.txt | |
sphinx-build -b html docs docs/build/html | |
- name: Publish the documentation | |
uses: JamesIves/[email protected] | |
with: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
BRANCH: gh-pages | |
FOLDER: docs/build/html | |
TARGET_FOLDER: improve-documentation | |
CLEAN: false |