Skip to content

Commit b7c5b5b

Browse files
Edits to maintenance/index.rst
1 parent 8d9f2e9 commit b7c5b5b

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

docs/source/maintenance/index.rst

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,41 @@ clone it:
1010
.. code-block::
1111
:caption: How to clone the repo
1212
13-
git clone https://github.com/<fork-org>/mkl_random.git
13+
git clone https://github.com/<fork-org>/mkl_random.git
1414
1515
1616
A working compiler is needed build :mod:`mkl_random`.
1717
Both Gnu :code:`g++` and Intel LLVM :code:`icpx` are supported.
1818

1919
Make sure to install Python packages required to build :mod:`mkl_random`:
2020

21-
* python
22-
* numpy
23-
* cython
24-
* setuptools
21+
* :mod:`python`
22+
* :mod:`numpy`
23+
* :mod:`cython`
24+
* :mod:`setuptools`
2525

2626
You would also need Intel(R) MKL library and its headers. Set :code:`MKLROOT` environment
2727
variable so that :code:`${MKLROOT}/include/mkl.h` and :code:`${MKLROOT}/lib/libmkl_rt.so`
2828
can be found.
2929

30-
.. code-block: bash
30+
.. code-block:: bash
3131
:caption: Building mkl_random
3232
33-
$ export MKLROOT=</path/to/mkl>
34-
python setup.py develop
33+
$ export MKLROOT=</path/to/mkl>
34+
python setup.py develop
35+
36+
To run test suite, install :mod:`pytest`, and run
37+
38+
.. code-block:: bash
39+
:caption: Running mkl_random test suite
40+
41+
python -m pytest mkl_random/tests
3542
3643
To build documentation, install dependencies and running
3744

38-
.. code-block: bash
45+
.. code-block:: bash
3946
:caption: Building mkl_random documentation
4047
41-
$ sphinx-build -M html docs/source docs/build
48+
$ sphinx-build -M html docs/source docs/build
4249
4350
Rendered documentation can be found in "docs/build/html".

0 commit comments

Comments
 (0)