Build and Deploy Docs #2
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: Build and Deploy Docs | |
on: | |
push: | |
tags: | |
- "v*" | |
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@v4 | |
with: | |
fetch-depth: 0 | |
- name: Make conda environment | |
uses: conda-incubator/setup-miniconda@v3 | |
with: | |
python-version: "3.10" # Python version to build the html sphinx documentation | |
environment-file: docs_env.yaml # Path to the documentation conda environment | |
auto-update-conda: false | |
auto-activate-base: false | |
show-channel-urls: true | |
- name: Installing the library | |
shell: bash -l {0} | |
run: | | |
python setup.py install | |
- name: Running the Sphinx to gh-pages Action | |
uses: uibcdf/action-sphinx-docs-to-gh-pages@v2.1.0 | |
with: | |
branch: main | |
dir_docs: docs | |
sphinx-apidoc-opts: '--separate -o . ../' | |
sphinx-apidoc-exclude: '../*setup* ../*.ipynb' | |
sphinx-opts: '' |