-
Notifications
You must be signed in to change notification settings - Fork 1
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
25cc471
commit 78bedd2
Showing
1 changed file
with
15 additions
and
12 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 |
---|---|---|
@@ -1,6 +1,9 @@ | ||
name: API Docs | ||
|
||
|
||
|
||
on: | ||
pull_request: | ||
release: | ||
types: | ||
- published | ||
|
@@ -39,20 +42,20 @@ jobs: | |
- name: Generate API docs | ||
run: ./.github/utils/pydoc-markdown.sh | ||
|
||
- name: Configure git to push docs | ||
run: | | ||
git config --global user.name docs-bot | ||
git config --global user.email [email protected] | ||
git config pull.rebase false | ||
git pull --allow-unrelated-histories origin gh-pages | ||
# - name: Configure git to push docs | ||
# run: | | ||
# git config --global user.name docs-bot | ||
# git config --global user.email [email protected] | ||
# git config pull.rebase false | ||
# git pull --allow-unrelated-histories origin gh-pages | ||
|
||
- name: Install dependencies for doc deployment | ||
run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike | ||
# - name: Install dependencies for doc deployment | ||
# run: pip install mkdocs-material mkdocstrings[python] mkdocs-mermaid2-plugin mike | ||
|
||
- name: Publish docs to pages | ||
run: | | ||
mike deploy --push --update-aliases ${{github.ref_name}} && \ | ||
mike set-default --push ${{github.ref_name}} | ||
# - name: Publish docs to pages | ||
# run: | | ||
# mike deploy --push --update-aliases ${{github.ref_name}} && \ | ||
# mike set-default --push ${{github.ref_name}} | ||
|
||
- name: Add Category ID to all API docs | ||
run: python ./.github/utils/add-category-id.py | ||
|