Merge pull request #5 from tdrose/dev #3
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 docs | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
sphinx_docs_to_gh-pages: | |
name: Sphinx docs to gh-pages | |
runs-on: ubuntu-latest | |
permissions: | |
contents: write | |
pages: write | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.9" | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip wheel | |
pip install -e ".[docs]" | |
- name: Install package | |
run: | | |
python -m pip install -vv --no-build-isolation . | |
- name: Running the Sphinx to gh-pages Action | |
# uses: uibcdf/[email protected] | |
# Workaround for bug about improper quoting of GitHub usernames with spaces: | |
# https://github.com/uibcdf/action-sphinx-docs-to-gh-pages/pull/8 | |
uses: aeisenbarth/action-sphinx-docs-to-gh-pages@patch-1 | |
with: | |
branch: master | |
dir_docs: docs | |
sphinx-apidoc-opts: "--separate -o . ../" | |
sphinx-apidoc-exclude: "" | |
sphinx-opts: "" |