Per #2750, user-provided should be hyphenated. #2885
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 | |
on: | |
push: | |
branches: | |
- develop | |
- develop-ref | |
- feature_* | |
- main_* | |
- bugfix_* | |
paths: | |
- docs/** | |
pull_request: | |
types: [opened, reopened, synchronize] | |
workflow_dispatch: | |
jobs: | |
documentation: | |
name: Build Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.8' | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade python-dateutil requests sphinx \ | |
sphinx-gallery Pillow sphinx_rtd_theme sphinx-panels | |
python -m pip install -r docs/requirements.txt | |
- name: Build docs | |
run: ./.github/jobs/build_documentation.sh | |
- uses: actions/upload-artifact@v4 | |
if: always() | |
with: | |
name: documentation | |
path: artifact/documentation | |
- uses: actions/upload-artifact@v4 | |
if: failure() | |
with: | |
name: documentation_warnings.log | |
path: artifact/doc_warnings.log | |
if-no-files-found: ignore |