-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Introduce mike for versioned doc (#270)
* Doc: Introduce mike for versioned doc
- Loading branch information
Showing
5 changed files
with
67 additions
and
36 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,38 @@ | ||
--- | ||
# This is deploying the latest commits on master to devel documentation | ||
name: Mkdocs | ||
on: | ||
push: | ||
branches: | ||
- master | ||
paths: | ||
# Run only if any of the following paths are changed when pushing to master | ||
# May need to update this | ||
- "docs/**" | ||
- "mkdocs.yml" | ||
|
||
jobs: | ||
'build_latest_doc': | ||
name: 'Update Public devel documentation' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: 'Setup Python 3 on runner' | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.x' | ||
|
||
- name: Setup Git config | ||
run: | | ||
git config --global user.name 'github-actions[bot]' | ||
git config --global user.email 'github-actions[bot]@users.noreply.github.com' | ||
- name: 'Build mkdocs content and deploy to gh-pages to devel' | ||
run: | | ||
pip install -r ./docs/requirements.txt | ||
mike deploy --push devel | ||
# This may not always be required | ||
mike set-default --push devel |
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 was deleted.
Oops, something went wrong.
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