-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation needs a working meshpy install to create the documentation Therefore, move the documentation creation to a separate workflow
- Loading branch information
1 parent
94e5551
commit 850e872
Showing
4 changed files
with
40 additions
and
13 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,33 @@ | ||
name: Build documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build_documentation: | ||
name: Build documentation | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
shell: bash | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v4 | ||
- name: Setup virtual python environment | ||
uses: ./.github/actions/setup_virtual_python_environment | ||
- name: Install dependencies | ||
run: | | ||
cd ${GITHUB_WORKSPACE} | ||
source python-testing-environment/bin/activate | ||
pip install -e .[CI-CD] | ||
- name: Build API documentation | ||
run: | | ||
source python-testing-environment/bin/activate | ||
pdoc --output-dir api-documentation meshpy/ | ||
- name: Upload API documentation artifact | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: api-documentation | ||
path: api-documentation/ |
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
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
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 |
---|---|---|
@@ -1,5 +1,4 @@ | ||
linkify-it-py | ||
myst-parser | ||
pdoc | ||
pydata-sphinx-theme | ||
sphinx |