-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added GH action for generating docs on release (#120)
- Loading branch information
1 parent
90b8269
commit b463eea
Showing
1 changed file
with
35 additions
and
0 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,35 @@ | ||
name: Sphinx docs to gh-pages | ||
on: | ||
release: | ||
types: [released] | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: write | ||
jobs: | ||
sphinx_docs_to_gh-pages: | ||
runs-on: ubuntu-latest | ||
name: Sphinx docs to gh-pages | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set up Python 3.9 | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3.9 | ||
- name: Installing the library | ||
shell: bash -l {0} | ||
run: | | ||
pip install https://github.com/glencoesoftware/zeroc-ice-py-linux-x86_64/releases/download/20240202/zeroc_ice-3.6.5-cp39-cp39-manylinux_2_28_x86_64.whl | ||
python setup.py install | ||
pip install sphinx | ||
- name: Running Sphinx | ||
shell: bash -l {0} | ||
run: | | ||
cd docs/sphinx | ||
sphinx-apidoc -f -o source ../../ezomero test | ||
sphinx-build -b html source ../ | ||
- name: Deploy to pages | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
folder: docs | ||
branch: "documentation" |