From abb42dcd4886705d6ba8af27f68ef605218ac67c Mon Sep 17 00:00:00 2001
From: Philip Paquette <pcpaquette@gmail.com>
Date: Wed, 11 Sep 2019 12:58:45 -0400
Subject: 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>
---
run_tests.sh | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
(limited to 'run_tests.sh')
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"
--
cgit v1.2.3