ISISComputingGroup / lewis-ess

Let's write intricate simulators!
GNU General Public License v3.0
21 stars 19 forks source link

Use tox for more reproducible testing #253

Closed MichaelWedel closed 7 years ago

MichaelWedel commented 7 years ago

This fixes #250.

There is now a configuration file for tox, providing a few different configurations and jobs for testing. I've followed the advice to move the lewis package itself into a separate src sub-directory. This has some consequences, namely that for being able to run the tests manually, one needs to install Lewis in the development virtualenv, usually in editable mode:

(lewis-dev)$ pip install -e ".[dev]"

The documentation has been updated accordingly and the process of running the tests manually and through tox is explained there.

To catch documentation errors earlier, building the documentation is now part of the Travis configuration as well (as a minor detail, the imgmath dependency for the documentation was removed because it was only used to display the Delta symbol - there was one unicode instance of it before, now all instances are unicode).

Please check also that the Dockerfile and .dockerignore files are okay.