You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2019/01/15 03:50:13 UTC
[GitHub] mli commented on issue #13132: enabled link checker and doc test
during building the doc
mli commented on issue #13132: enabled link checker and doc test during building the doc
URL: https://github.com/apache/incubator-mxnet/pull/13132#issuecomment-454258195
doctest will evaluate the python codes in the docstring. for example, if i wrote
```
>>> print(1+1)
2
```
then doctest will evaluate the first sentence and then compare the returned results with the second line. It guantees the codes we put int the doc will return the results we think they should generate.
The main purpose of linktest is check the internal reference in documents, such as :py:doc:`mxnet.ndarray`.
These two are standard tests for python documents, which are suppported by sphinx. If they are covered in other CI stages, it's OK to close this PR.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services