Add auto-generated docs, Read the Docs support, and GitHub Actions wo… #2
Workflow file for this run
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
name: lint-test-cover-docs | |
on: | |
push | |
jobs: | |
lint_test_cover_docs: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ['3.7', '3.8', '3.9', '3.10', '3.11'] | |
name: "Python ${{ matrix.python-version }}" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Install Python. | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
architecture: x64 | |
- name: Lint and test module. | |
run: | | |
pip install -U .[lint,test] | |
python -m pylint richreports # Check against linting rules. | |
python -m pytest # Run tests. | |
python src/richreports/richreports.py -v # Run tests via execution. | |
- name: Publish coverage results. | |
run: | | |
pip install -U .[coveralls] | |
python -m coveralls --service=github # Submit to coveralls. | |
if: matrix.python-version == '3.11' | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }} | |
- name: Test auto-generation of documentation. | |
run: | | |
pip install -U .[docs] | |
cd docs && sphinx-apidoc -f -E --templatedir=_templates -o _source .. && make html && cd .. |