Skip to content

Commit 67ffbb5

Browse files
author
Jon Wedell
committed
Tweak unit testing documentation.
1 parent 8d24061 commit 67ffbb5

File tree

4 files changed

+31
-47
lines changed

4 files changed

+31
-47
lines changed

README.rst

-9
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,3 @@ is to read the documentation at `read the docs <https://pynmrstar.readthedocs.or
2525

2626
.. |Wheel| image:: https://img.shields.io/pypi/wheel/pynmrstar.svg
2727
:target: https://pypi.org/project/PyNMRSTAR
28-
29-
30-
Running the unit tests
31-
----------------------
32-
33-
.. role:: bash(code)
34-
:language: bash
35-
36-
if you with to run the unit tests distributed with PyNMR-Star, please see the readme in :bash:`pynmrstar/unit_tests`

docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Previous python versions (back to 2.6) are supported by the v2 branch
1515
usage/quick-start
1616
usage/examples
1717
usage/full
18+
usage/unit-test
1819
release-notes
1920

2021

docs/usage/unit-test.rst

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
How to run the unit tests
2+
=========================
3+
4+
Setup
5+
-----
6+
7+
All the following commands should be executed from a shell inside the
8+
PyNMRSTAR distribution folder (``PyNMRSTAR`` not ``PyNMRSTAR/pynmrstar``).
9+
10+
Some parts of the unit test structure are in a git submodule that needs to be
11+
downloaded separately.
12+
13+
.. code:: bash
14+
15+
git submodule init
16+
git submodule update
17+
18+
Using unit test
19+
---------------
20+
21+
.. code:: bash
22+
23+
python3 -m pynmrstar.unit_tests
24+
25+
Using pytest
26+
------------
27+
28+
.. code:: bash
29+
30+
pytest

pynmrstar/unit_tests/README.rst

-38
This file was deleted.

0 commit comments

Comments
 (0)