Skip to content

Commit

Permalink
Add CI/CD with github actions
Browse files Browse the repository at this point in the history
Trigger an Github action on pull requests that builds the HTML version of the documentation for continuous integration and easy deployment.
  • Loading branch information
SiemondeLange committed Sep 30, 2022
1 parent f5c2ecf commit d10f2ef
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: "Pull Request Docs Check"
on:
- pull_request

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install Python dependencies
uses: py-actions/py-dependency-install@v3
with:
path: "requirements.txt"
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "."
build-command: "sphinx-build -b html . _build/html"
- name: Replace index file
run: |
sudo cp ./_index/index.html ./_build/html
sudo cp -r ./_index/assets ./_build/html
- uses: actions/upload-artifact@v1
with:
name: DocumentationHTML
path: ./_build/html/
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sphinxcontrib-bibtex
sphinxcontrib-contentui

0 comments on commit d10f2ef

Please sign in to comment.