Fix documentation errors (#54) #21
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
# After successful versioning, this script runs various | |
# parts of the push process | |
name: Push | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
lint: | |
runs-on: ubuntu-latest | |
name: Lint | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install black | |
- name: Check formatting | |
run: black . -l 79 --check | |
test: | |
name: Build and test | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # Fetch all history for all tags and branches | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: Install package | |
run: make install | |
- name: Download data inputs | |
run: make download | |
env: | |
HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }} | |
- name: Build datasets | |
run: make data | |
- name: Run tests | |
run: pytest | |
- name: Upload data | |
run: make upload | |
env: | |
HUGGING_FACE_TOKEN: ${{ secrets.HUGGING_FACE_TOKEN }} | |
- name: Test documentation builds | |
run: make documentation | |
- name: Build Jupyter Book | |
run: make documentation | |
- name: Deploy documentation | |
uses: JamesIves/github-pages-deploy-action@releases/v4 | |
with: | |
branch: gh-pages | |
folder: docs/_build/html | |
publish-to-pypi: | |
name: Publish to PyPI | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # Fetch all history for all tags and branches | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.12 | |
- name: Install package | |
run: make install | |
- name: Build package | |
run: python -m build | |
- name: Publish a git tag | |
run: ".github/publish-git-tag.sh || true" | |
- name: Publish to PyPI | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
with: | |
user: __token__ | |
password: ${{ secrets.PYPI }} | |
skip-existing: true |