Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Github action to generate docset #201

Merged
merged 2 commits into from
Feb 18, 2022
Merged

Add Github action to generate docset #201

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e73169
Add build docset step
aldur Feb 17, 2022
0a3dd55
non-slim container
aldur Feb 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,30 @@ jobs:
mypy pyteal
python3 -c "import pyteal" scripts/generate_init.py --check
black --check .
build-docset:
runs-on: ubuntu-20.04
container: python:3.9 # Needs `make`, can't be slim
steps:
- name: Check out code
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Install pip dependencies
run: |
pip install -r requirements.txt
pip install -r docs/requirements.txt
pip install doc2dash
- name: Make docs
run: |
cd docs
make html
doc2dash --name pyteal --index-page index.html --online-redirect-url https://pyteal.readthedocs.io/en/ _build/html
tar -czvf pyteal.docset.tar.gz pyteal.docset
- name: Archive docset
uses: actions/upload-artifact@v2
with:
name: pyteal.docset
path: docs/pyteal.docset.tar.gz
upload-to-pypi:
runs-on: ubuntu-20.04
needs: ['build-test']
Expand Down