-
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.
feat: Fix documentation commands for github actions (#13)
- Loading branch information
1 parent
510d169
commit ba9b1c1
Showing
1 changed file
with
3 additions
and
2 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 |
---|---|---|
|
@@ -13,14 +13,15 @@ jobs: | |
pip install sphinx | ||
python -m pip install sphinx-autoapi | ||
python -m pip install sphinx_rtd_theme | ||
python -m pip install tox tox-gh-actions | ||
- name: Sphinx build | ||
run: | | ||
sphinx-build doc _build | ||
tox -e docs | ||
- name: Deploy | ||
uses: peaceiris/[email protected] | ||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | ||
with: | ||
publish_branch: gh-pages | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: _build/ | ||
publish_dir: .tox/docs/tmp/html/ | ||
force_orphan: true |