Tianshou/.github/workflows/lint_and_docs.yml
n+e b86d78766b
fix docs and add docstring check (#210)
- fix broken links and out-of-the-date content
- add pydocstyle and doc8 check
- remove collector.seed and collector.render
2020-09-11 07:55:37 +08:00

30 lines
708 B
YAML

name: PEP8 and Docs Check
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
uses: actions/setup-python@v2
with:
python-version: 3.8
- name: Upgrade pip
run: |
python -m pip install --upgrade pip setuptools wheel
- name: Install dependencies
run: |
python -m pip install ".[dev]" --upgrade
- name: Lint with flake8
run: |
flake8 . --count --show-source --statistics
- name: Documentation test
run: |
pydocstyle tianshou
doc8 docs --max-line-length 1000
cd docs
make html SPHINXOPTS="-W"
cd ..