general editing + some formatting fun #63
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: Sphinx docs to gh-pages | |
on: | |
push: | |
branches: | |
- master | |
# workflow_dispatch: # Un comment line if you also want to trigger action manually | |
jobs: | |
sphinx_docs_to_gh-pages: | |
runs-on: ubuntu-latest | |
name: Sphinx docs to gh-pages | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- name: Make conda environment | |
uses: conda-incubator/setup-miniconda@v2 | |
with: | |
python-version: 3.9 # Python version to build the html sphinx documentation | |
environment-file: devtools/conda-envs/docs_env.yaml # Path to the documentation conda environment | |
auto-update-conda: false | |
auto-activate-base: false | |
show-channel-urls: true | |
- name: Running the Sphinx to gh-pages Action | |
uses: uibcdf/[email protected] | |
with: | |
branch: master | |
dir_docs: docs | |
sphinxapiopts: '--separate -o . ../' | |
sphinxapiexclude: '../*setup* ../*.ipynb' | |
sphinxopts: '' |