Skip to content

Commit

Permalink
test docs build separately from pages deploy
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Mirz <[email protected]>
  • Loading branch information
m-mirz committed Jan 4, 2025
1 parent 4821d67 commit c4f64d0
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
name: Documentation

on:
pull_request:

push:
branches:
- master
Expand Down
41 changes: 40 additions & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Pytest
name: Pytest and Sphinx

on:
push:
Expand Down Expand Up @@ -33,3 +33,42 @@ jobs:
with:
name: pytest-results
path: report.xml

test-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.8

- name: Install Graphviz
shell: bash
run: |
sudo apt-get -y install graphviz
- name: Install Python dependencies
run: |
pip install .[doc]
- name: Build documentation
working-directory: documentation
run: |
sphinx-apidoc \
--full \
--doc-project "cimpy" \
--separate \
--output-dir "." \
"../"
python3 set_inheritance_diagram.py
make html
touch _build/html/.nojekyll
ls -l _build/html

0 comments on commit c4f64d0

Please sign in to comment.