Skip to content

Commit 2170f4e

Browse files
CI: Using docstring validator from numpydoc (#30746)
1 parent c139f08 commit 2170f4e

5 files changed

+163
-1811
lines changed

ci/code_checks.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,8 @@ fi
314314
### DOCSTRINGS ###
315315
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
316316

317-
MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA01, SA02, SA03, SA05)' ; echo $MSG
318-
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA01,SA02,SA03,SA05
317+
MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, GL10, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA02, SA03, SA05)' ; echo $MSG
318+
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03,SA05
319319
RET=$(($RET + $?)) ; echo $MSG "DONE"
320320

321321
fi

environment.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ dependencies:
2727
# documentation
2828
- gitpython # obtain contributors from git for whatsnew
2929
- sphinx
30-
- numpydoc>=0.9.0
3130

3231
# documentation (jupyter notebooks)
3332
- nbconvert>=5.4.1
@@ -105,3 +104,4 @@ dependencies:
105104
- tabulate>=0.8.3 # DataFrame.to_markdown
106105
- pip:
107106
- git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
107+
- git+https://github.com/numpy/numpydoc

requirements-dev.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ mypy==0.730
1616
pycodestyle
1717
gitpython
1818
sphinx
19-
numpydoc>=0.9.0
2019
nbconvert>=5.4.1
2120
nbsphinx
2221
pandoc
@@ -70,4 +69,5 @@ sqlalchemy
7069
xarray
7170
pyreadstat
7271
tabulate>=0.8.3
73-
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
72+
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
73+
git+https://github.com/numpy/numpydoc

0 commit comments

Comments
 (0)