diff --git a/ci/jenkins/build_steps.groovy b/ci/jenkins/build_steps.groovy index f2563adad7..b7b900f753 100644 --- a/ci/jenkins/build_steps.groovy +++ b/ci/jenkins/build_steps.groovy @@ -117,7 +117,6 @@ def website_linkcheck(workspace_name, conda_env_name) { if [[ ${enforce_linkcheck} == true ]]; then make -C docs linkcheck SPHINXOPTS=-W else - set +e make -C docs linkcheck fi; set +ex diff --git a/docs/community/contribute.rst b/docs/community/contribute.rst index 7835d5a380..32d67afa75 100644 --- a/docs/community/contribute.rst +++ b/docs/community/contribute.rst @@ -41,10 +41,15 @@ Make changes ------------ Our package uses continuous integration and code coverage tools for verifying pull requests. Before -submitting, contributor should perform the following checks: +submitting, contributor should ensure that the following checks do not fail: -- `Lint (code style) check `__. -- `Py2 `__ and `Py3 `__ tests. +- Lint (code style) +- Unittest (running under Python 2 and Python 3) +- Doctest (running under Python 2 and Python 3) + +The commands executed by the continuous integration server to perform the tests +are listed in the `build_steps.groovy file +`__. Contribute to model zoo ----------------------- diff --git a/docs/index.rst b/docs/index.rst index 204a59b3de..28c0681356 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -99,8 +99,9 @@ This toolkit assumes that users have basic knowledge about deep learning and NLP. Otherwise, please refer to an introductory course such as `Dive into Deep Learning `_ or `Stanford CS224n `_. -If you are not familiar with Gluon, check out the -`60-min Gluon crash course `_. +If you are not familiar with Gluon, check out the `Gluon documentation +`__. +You may find the 60-min Gluon crash course linked from there especially helpful. .. toctree::