Merge pull request #211 from PufferBlow/main #92
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 | |
on: | |
push: | |
branches: | |
- main | |
- docs | |
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 | |
token: ${{ secrets.GH_PAT }} | |
- 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: devtools/cond-envs/docs_env.yaml # Path to the documentation conda environment | |
miniconda-version: "latest" | |
auto-update-conda: false | |
auto-activate-base: false | |
show-channel-urls: true | |
- name: Install Git | |
run: sudo apt-get update && sudo apt-get install -y git | |
- name: Running the Sphinx to gh-pages Action | |
uses: uibcdf/[email protected] | |
with: | |
branch: main | |
dir_docs: docs | |
sphinx-apidoc-opts: '--separate -o . ../' | |
sphinx-apidoc-exclude: '../*setup* ../*.ipynb' | |
sphinx-opts: '' |