Add automatic tests to rst doc code snippets #272
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #268
Nits: since most of the tests use SST, the
.. testcleanup:: [flag]needs to be updated to the last test executed in eachrstfile so the downloaded files get deleted.This can be done via the global cleanup argument in conf.py, but then SST is downloaded again for each test group and that takes too much time.
Some larger snippets were skipped (e.g. downloading GloVe, running Iterators over IMDB & downloading IMDB).
@mariosasko
make html doesn't run the tests -- right now I run them manually withsphinx-build -b doctest source buildfrom thedocsfolder. Can we add this to a make command for running tests?Doc tests can be ran by
make doctestfrom the docs folder.