Skip to content

Commit

Permalink
Simplify CI action for building docs
Browse files Browse the repository at this point in the history
Signed-off-by: Steffen Vogel <steffen.vogel@opal-rt.com>
  • Loading branch information
stv0g committed Jun 17, 2024
1 parent 2281949 commit 238a50b
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 95 deletions.
60 changes: 60 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Build documentation

on:
pull_request:

push:
branches:
- master

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
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
- 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
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Install Python dependencies
run: |
pip install .[dev,doc]
pip install .[dev]
- name: Run pytest
run: |
Expand Down
35 changes: 0 additions & 35 deletions .github/workflows/workflow.yaml

This file was deleted.

32 changes: 0 additions & 32 deletions Dockerfile

This file was deleted.

7 changes: 0 additions & 7 deletions action.yaml

This file was deleted.

12 changes: 0 additions & 12 deletions documentation/docu.sh

This file was deleted.

8 changes: 0 additions & 8 deletions entrypoint.sh

This file was deleted.

0 comments on commit 238a50b

Please sign in to comment.