Skip to content

Merge pull request #124 from PufferBlow/docs #5

Merge pull request #124 from PufferBlow/docs

Merge pull request #124 from PufferBlow/docs #5

Workflow file for this run

name: Sphinx docs
on:
push:
branches:
- main
- docs
workflow_dispatch:

Check failure on line 9 in .github/workflows/sphinx-doc.yaml

View workflow run for this annotation

GitHub Actions / Sphinx docs

Invalid workflow file

The workflow is not valid. .github/workflows/sphinx-doc.yaml (Line: 9, Col: 1): Unexpected value 'workflow_dispatch'
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.10 # 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: Installing the library
# shell: bash -l {0}
# run: |
# python setup.py install
- 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: ''