-
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.
Change to wait for End of Transmission token
- Loading branch information
1 parent
f5fcec9
commit 81f3ef2
Showing
13 changed files
with
133 additions
and
410 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,52 +1,44 @@ | ||
name: Docs | ||
name: Generate Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
deploy: | ||
runs-on: ubuntu-18.04 | ||
generate_documentation: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@master | ||
- uses: actions/checkout@v2 | ||
with: | ||
token: "${{secrets.TOKEN}}" | ||
- uses: actions/setup-python@v2 | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
- name: Setup Python | ||
- name: Set up Python | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: '3.8' | ||
python-version: 3.x | ||
|
||
- name: Upgrade pip | ||
- name: Install dependencies | ||
run: | | ||
python3 -m pip install --upgrade pip | ||
python -m pip install --upgrade pip | ||
python -m pip install -r pyduino/requirements.txt | ||
pip install pydoc-markdown | ||
- name: Get pip cache dir | ||
id: pip-cache | ||
run: echo "::set-output name=dir::$(pip cache dir)" | ||
- name: Generate documentation | ||
run: pydoc-markdown --render-toc -I pyduino -o docs | ||
|
||
- name: Install Sphinx | ||
run: python3 -m pip install -U sphinx myst-parser sphinxcontrib-mermaid furo pylint sphinx-autopackagesummary | ||
- name: Configure Git | ||
run: | | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "GitHub Action" | ||
- name: Install dependencies | ||
working-directory: ./pyduino | ||
run: python3 -m pip install -r ./requirements.txt | ||
|
||
- name: Run make | ||
working-directory: ./doc/docs | ||
run: make html | ||
|
||
- name: Add .nojekyll | ||
working-directory: ./doc/docs/build/html | ||
run: touch .nojekyll | ||
|
||
- name: Deploy to gh-pages | ||
uses: s0/git-publish-subdir-action@develop | ||
env: | ||
REPO: self | ||
BRANCH: gh-pages | ||
FOLDER: ./doc/docs/build/html | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
- name: Commit changes | ||
run: | | ||
git checkout gh-pages | ||
git add docs | ||
git commit -m "Update documentation" | ||
- name: Push changes | ||
uses: ad-m/[email protected] | ||
with: | ||
branch: gh-pages |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.