-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
190bcb7
commit 1915718
Showing
1 changed file
with
37 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,37 @@ | ||
name: CD | ||
on: | ||
push: | ||
branches: | ||
- master | ||
jobs: | ||
docs: | ||
name: Deploy API Documentation | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Set up Python 3.8.18 | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.8.18" | ||
- name: Install dependencies | ||
run: | | ||
pip install . | ||
pip install sphinx | ||
sphinx-build --version | ||
- name: Build API documentation | ||
run: | | ||
sphinx-apidoc -o docs . | ||
cd docs | ||
- name: Make HTML files | ||
run: | | ||
cd docs | ||
make html | ||
- name: Deploy API documentation | ||
uses: peaceiris/[email protected] | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_branch: gh-pages | ||
publish_dir: docs/_build/html |