Skip to content

Commit 3ba1787

Browse files
committed
enhancement #37: check docstring in CI
1 parent 2bca5e2 commit 3ba1787

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

.github/workflows/docs.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@ name: Generate Python Documentation
33
on: [pull_request]
44

55
jobs:
6+
check-docstrings:
7+
runs-on: ubuntu-22.04
8+
steps:
9+
- uses: actions/checkout@v3
10+
- name: Set up Python 3.10
11+
uses: actions/setup-python@v4
12+
with:
13+
python-version: "3.10"
14+
cache: 'pip' # caching pip dependencies
15+
- name: Install dependencies
16+
run: |
17+
python -m pip install --upgrade pip
18+
pip install .[dev]
19+
- name : Check import order
20+
run : pydocstyle src/ --convention google --count
21+
622
build-docs:
723
runs-on: ubuntu-22.04
824
steps:

0 commit comments

Comments
 (0)