-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create build sphinx github action workflow
- Loading branch information
1 parent
92f5dcc
commit b4a411b
Showing
1 changed file
with
40 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,40 @@ | ||
name: Build Sphinx Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- main # Adjust this to your main branch | ||
pull_request: | ||
branches: | ||
- main # Optionally build on PRs to the main branch | ||
|
||
jobs: | ||
build-docs: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Check out the repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.8' # Specify your required Python version | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install -r docs/requirements.txt | ||
# Add other Sphinx dependencies here | ||
- name: Build the documentation | ||
run: | | ||
cd docs | ||
make html | ||
- name: Upload Documentation | ||
uses: actions/upload-artifact@v3 | ||
with: | ||
name: sphinx-docs | ||
path: docs/build/html | ||
|