12
12
# $ ./ci/code_checks.sh doctests # run doctests
13
13
# $ ./ci/code_checks.sh docstrings # validate docstring errors
14
14
# $ ./ci/code_checks.sh typing # run static type analysis
15
+ # $ ./ci/code_checks.sh single-docs # check single-page docs build warning-free
15
16
16
- [[ -z " $1 " || " $1 " == " code" || " $1 " == " doctests" || " $1 " == " docstrings" || " $1 " == " typing" ]] || \
17
+ [[ -z " $1 " || " $1 " == " code" || " $1 " == " doctests" || " $1 " == " docstrings" || " $1 " == " typing" || " $1 " == " single-docs " ]] || \
17
18
{ echo " Unknown command $1 . Usage: $0 [code|doctests|docstrings|typing]" ; exit 9999; }
18
19
19
20
BASE_DIR=" $( dirname $0 ) /.."
78
79
# ## DOCSTRINGS ###
79
80
if [[ -z " $CHECK " || " $CHECK " == " docstrings" ]]; then
80
81
81
- MSG=' Validate docstrings (EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT04, RT05, SA02, SA03, SS01, SS02, SS03, SS04, SS05)' ; echo $MSG
82
- $BASE_DIR /scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SS01,SS02,SS03,SS04,SS05
82
+ MSG=' Validate docstrings (EX04, GL01, GL02, GL03, GL04, GL05, GL06, GL07, GL09, GL10, PR03, PR04, PR05, PR06, PR08, PR09, PR10, RT01, RT04, RT05, SA02, SA03, SA04, SS01, SS02, SS03, SS04, SS05)' ; echo $MSG
83
+ $BASE_DIR /scripts/validate_docstrings.py --format=actions --errors=EX04,GL01,GL02,GL03,GL04,GL05,GL06,GL07,GL09,GL10,PR03,PR04,PR05,PR06,PR08,PR09,PR10,RT01,RT04,RT05,SA02,SA03,SA04, SS01,SS02,SS03,SS04,SS05
83
84
RET=$(( $RET + $? )) ; echo $MSG " DONE"
84
85
85
86
fi
@@ -102,4 +103,11 @@ if [[ -z "$CHECK" || "$CHECK" == "typing" ]]; then
102
103
fi
103
104
fi
104
105
106
+ # ## SINGLE-PAGE DOCS ###
107
+ if [[ -z " $CHECK " || " $CHECK " == " single-docs" ]]; then
108
+ python doc/make.py --warnings-are-errors --single pandas.Series.value_counts
109
+ python doc/make.py --warnings-are-errors --single pandas.Series.str.split
110
+ python doc/make.py clean
111
+ fi
112
+
105
113
exit $RET
0 commit comments