Skip to content

Commit

Permalink
Add doc validation workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
timj committed Dec 14, 2023
1 parent 4bf15e1 commit b80bb05
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/docstyle.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Run docstyle

on:
push:
branches:
- main
pull_request:

jobs:
call-workflow:
uses: lsst/rubin_workflows/.github/workflows/docstyle.yaml@main
with:
args: "python/"
numpydoc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4

- name: Install numpydoc
run: |
python -m pip install --upgrade pip
python -m pip install numpydoc
- name: Validate docstrings
run: python -m numpydoc.hooks.validate_docstrings $(find python -name "*.py")

0 comments on commit b80bb05

Please sign in to comment.