-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Simplify CI action for building docs
Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com>
- Loading branch information
Showing
6 changed files
with
59 additions
and
94 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
name: Documentation | ||
|
||
on: | ||
pull_request: | ||
|
||
push: | ||
branches: | ||
- master | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
jobs: | ||
build-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 .[dev,doc] | ||
- name: Build documentation | ||
run: | | ||
sphinx-apidoc \ | ||
--full \ | ||
--doc-project "cimpy" \ | ||
--separate \ | ||
--output-dir "../documentation" \ | ||
"../" | ||
python3 set_inheritance_diagram.py | ||
make html | ||
touch ./documentation/_build/html/.nojekyll | ||
ls -l ./documentation/_build/html | ||
- name: Upload Artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: ./documentation/_build/html | ||
|
||
- name: Deploy to GitHub Pages | ||
if: github.ref == 'refs/heads/master' | ||
uses: actions/deploy-pages@v4 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.