Skip to content

WIP documentation generation via gh actions #163

WIP documentation generation via gh actions

WIP documentation generation via gh actions #163

Workflow file for this run

name: Workflow for CI and Codecov Action
on: [push, pull_request]
jobs:
run:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]
env:
OS: ${{ matrix.os }}
PYTHON: "3.10"
steps:
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
pip install pdoc3
pip install pytest
pip install pytest-cov
pip install -e .
- name: Update documentation
run: |
pdoc --html pearl.neural_networks.common --html-dir .html --force
# - name: Generate coverage report
# run: |
# pytest --cov=./ --cov-report=xml
# - name: Upload coverage to Codecov
# if: success() || failure()
# uses: codecov/codecov-action@v4
# with:
# env_vars: OS,PYTHON
# file: ./coverage.xml
# flags: unittests
# name: codecov-umbrella
# token: ${{ secrets.CODECOV_TOKEN }}
# slug: facebookresearch/Pearl
# verbose: true