diff options
author | Philip Paquette <pcpaquette@gmail.com> | 2019-09-11 12:58:45 -0400 |
---|---|---|
committer | Philip Paquette <pcpaquette@gmail.com> | 2019-09-14 18:18:53 -0400 |
commit | abb42dcd4886705d6ba8af27f68ef605218ac67c (patch) | |
tree | 9ae16f7a09fff539fa72e65198e284bca6ac3376 /run_tests.sh | |
parent | a954a00d263750c279dbb2c0a9ae85707022bcd7 (diff) |
Added ReadtheDocs documentation for the public API
- Reformatted the docstring to be compatible
- Added tests to make sure the documentation compiles properly
- Added sphinx as a pip requirement
Co-authored-by: Philip Paquette <pcpaquette@gmail.com>
Co-authored-by: notoraptor <stevenbocco@gmail.com>
Diffstat (limited to 'run_tests.sh')
-rwxr-xr-x | run_tests.sh | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/run_tests.sh b/run_tests.sh index c8316fb..dde540f 100755 --- a/run_tests.sh +++ b/run_tests.sh @@ -12,9 +12,30 @@ if [ "${1:-auto}" != "0" ]; then fi # Running pylint +echo "" +echo "------------------------------" +echo " PYLINT TESTS " +echo "------------------------------" +echo "" find diplomacy -name "*.py" ! -name 'zzz_*.py' ! -name '_*.py' -exec pylint '{}' + || FAILED=1 +# Running sphinx +echo "" +echo "------------------------------" +echo " SPHINX TESTS " +echo "------------------------------" +echo "" +cd $DIR/docs +make clean || FAILED=1 +make html || FAILED=1 +cd - + # Running eslint +echo "" +echo "------------------------------" +echo " ESLINT TESTS " +echo "------------------------------" +echo "" if [ -f "$DIR/diplomacy/web/node_modules/.bin/eslint" ]; then if [ -z ${NVM_DIR+x} ]; then export NVM_DIR="$HOME/.nvm" |