-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #355 from valentin-petzold/feature/sphinx_docu_to_…
…pages sphinx to gh workflow
- Loading branch information
Showing
2 changed files
with
27 additions
and
1 deletion.
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,26 @@ | ||
# For reference: https://github.com/JamesIves/github-pages-deploy-action | ||
name: Build Sphinx docu. | ||
|
||
on: | ||
release: | ||
types: [published] | ||
permissions: | ||
contents: write | ||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Install and Build HTML | ||
run: | | ||
pip install --upgrade pip | ||
pip install sphinx sphinx-rtd-theme | ||
pip install ".[full]" | ||
sphinx-build ./docs/source ./docs/build | ||
- name: Deploy HTML | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
folder: docs/build/ # The folder the action should deploy. |
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