From 08eec3d82bd36216f6aea097c3daaae400723d9d Mon Sep 17 00:00:00 2001 From: John Evans Date: Mon, 24 Jun 2013 08:54:29 -0400 Subject: [PATCH] Updated docs to reflect running tests from within python. --- docs/source/detailed_installation.rst | 8 +++++++- docs/source/introduction.rst | 8 ++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/source/detailed_installation.rst b/docs/source/detailed_installation.rst index 1771722..0037ccf 100644 --- a/docs/source/detailed_installation.rst +++ b/docs/source/detailed_installation.rst @@ -96,7 +96,13 @@ Not currently supported. Testing ''''''' -If you wish to run the tests (strongly suggested :-), try the following +If you wish to run the tests (strongly suggested :-), you can either run them +from within python as follows ... :: + + >>> import glymur + >>> glymur.runtests() + +or from the unix command line. :: $ cd /to/where/you/unpacked/glymur $ python -m unittest discover diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index d21d7eb..834ecc7 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -70,3 +70,11 @@ to take advantage of it. For example, if you install with pip's $ export PYTHONPATH=$HOME/.local/lib/python3.3/site-packages $ export PATH=$HOME/.local/bin:$PATH + +You can run the tests from within python as follows:: + + >>> import glymur + >>> glymur.runtests() + +Many tests are currently skipped; the important thing is whether or not any +tests fail.