Readme consult status page #16
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: Documentation | |
env: | |
PYTHON_VERSION: "3.10" | |
on: | |
pull_request: | |
branches: | |
- main | |
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: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ env.PYTHON_VERSION }} | |
cache: "pip" | |
- name: Install dependencies | |
run: pip install -r requirements.dev.txt | |
- name: Running the Sphinx to gh-pages Action | |
uses: uibcdf/[email protected] | |
with: | |
branch: main | |
dir_docs: docs/source | |
sphinxapiopts: '--separate -o . ../' | |
sphinxapiexclude: '../*setup* ../*.ipynb' | |
sphinxopts: '' |