Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add check for documentation building #699

Merged
Merged
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/workflows/check-documentation-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Documentation Check

on:
push:
branches:
- "main"
paths:
- "docs/**"
- ".readthedocs.yaml"
- "setup.py"
- ".github/workflows/check-documentation-build.yml"

pull_request:
branches:
- "main"
- "stable"
paths:
- "docs/**"
- ".readthedocs.yaml"
- "setup.py"
- ".github/workflows/check-documentation-build.yml"
LeonLuttenberger marked this conversation as resolved.
Show resolved Hide resolved

jobs:
build:
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Install yq
run: sudo snap install yq
- name: Get Python Version
id: get-version
run: |
python_version=$(cat .readthedocs.yaml | yq ".build.tools.python")
echo python-version=$python_version >> $GITHUB_OUTPUT
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '${{ steps.get-version.outputs.python-version }}'
- name: Update pip
run: pip install --upgrade pip
- name: Install Requirements for building docs
run: pip install -r docs/requirements-docs.txt
- name: Install SeedFarmer
run: pip install -e .
- name: Sphinx Build
working-directory: ./docs/
run: make html
Loading