35401fe50f
* Switch to plain unittest for skipping slow tests.
Add a RUN_SLOW environment variable for running them.
* Switch to plain unittest for PyTorch dependency.
* Switch to plain unittest for TensorFlow dependency.
* Avoid leaking open files in the test suite.
This prevents spurious warnings when running tests.
* Fix unicode warning on Python 2 when running tests.
The warning was:
UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
* Support running PyTorch tests on a GPU.
Reverts 27e015bd.
* Tests no longer require pytest.
* Make tests pass on cuda
Generating the documentation
To generate the documentation, you first have to build it. Several packages are necessary to build the doc, you can install them using:
pip install -r requirements.txt
Packages installed
Here's an overview of all the packages installed. If you ran the previous command installing all packages from
requirements.txt, you do not need to run the following commands.
Building it requires the package sphinx that you can
install using:
pip install -U sphinx
You would also need the custom installed theme by Read The Docs. You can install it using the following command:
pip install sphinx_rtd_theme
The third necessary package is the recommonmark package to accept Markdown as well as Restructured text:
pip install recommonmark
Building the documentation
Make sure that there is a symlink from the example file (in /examples) inside the source folder. Run the following
command to generate it:
ln -s ../../examples/README.md examples.md
Once you have setup sphinx, you can build the documentation by running the following command in the /docs folder:
make html
NOTE
If you are adding/removing elements from the toc-tree or from any structural item, it is recommended to clean the build directory before rebuilding. Run the following command to clean and build:
make clean && make html
It should build the static app that will be available under /docs/_build/html
Adding a new element to the tree (toc-tree)
Accepted files are reStructuredText (.rst) and Markdown (.md). Create a file with its extension and put it in the source directory. You can then link it to the toc-tree by putting the filename without the extension.