diff --git a/.travis.yml b/.travis.yml index cba0f41..b76401c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,6 +8,7 @@ install: - "pip install pip --upgrade" - "pip install -r tests-requirements.txt" - "pip install -r requirements.txt" + - "npm install -g remark-cli remark-validate-links" script: ./tests.sh after_success: diff --git a/README.md b/README.md index a73726b..04e306e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # DOTDROP [![Build Status](https://travis-ci.org/deadc0de6/dotdrop.svg?branch=master)](https://travis-ci.org/deadc0de6/dotdrop) +[![Doc Status](https://readthedocs.org/projects/dotdrop/?version=latest)](https://dotdrop.readthedocs.io/en/latest/?badge=latest) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0) [![Coverage Status](https://coveralls.io/repos/github/deadc0de6/dotdrop/badge.svg?branch=master)](https://coveralls.io/github/deadc0de6/dotdrop?branch=master) [![PyPI version](https://badge.fury.io/py/dotdrop.svg)](https://badge.fury.io/py/dotdrop) diff --git a/tests.sh b/tests.sh index 16be406..053f739 100755 --- a/tests.sh +++ b/tests.sh @@ -69,4 +69,17 @@ unset DOTDROP_FORCE_NODEBUG rm -f ${log} } +## test the doc with remark +## https://github.com/remarkjs/remark-validate-links +set +e +which remark >/dev/null 2>&1 +r="$?" +set -e +if [ "$r" != "0" ]; then + echo "[WARNING] install \"remark\" to test the doc" +else + remark -f -u validate-links docs/ +fi + +## done echo "All test finished successfully"