diff --git a/docs/source/maintenance/index.rst b/docs/source/maintenance/index.rst index 00ba2bf..2611957 100644 --- a/docs/source/maintenance/index.rst +++ b/docs/source/maintenance/index.rst @@ -10,7 +10,7 @@ clone it: .. code-block:: :caption: How to clone the repo - git clone https://github.com//mkl_random.git + git clone https://github.com//mkl_random.git A working compiler is needed build :mod:`mkl_random`. @@ -18,26 +18,33 @@ Both Gnu :code:`g++` and Intel LLVM :code:`icpx` are supported. Make sure to install Python packages required to build :mod:`mkl_random`: -* python -* numpy -* cython -* setuptools +* :mod:`python` +* :mod:`numpy` +* :mod:`cython` +* :mod:`setuptools` You would also need Intel(R) MKL library and its headers. Set :code:`MKLROOT` environment variable so that :code:`${MKLROOT}/include/mkl.h` and :code:`${MKLROOT}/lib/libmkl_rt.so` can be found. -.. code-block: bash +.. code-block:: bash :caption: Building mkl_random - $ export MKLROOT= - python setup.py develop + $ export MKLROOT= + python setup.py develop + +To run test suite, install :mod:`pytest`, and run + +.. code-block:: bash + :caption: Running mkl_random test suite + + python -m pytest mkl_random/tests To build documentation, install dependencies and running -.. code-block: bash +.. code-block:: bash :caption: Building mkl_random documentation - $ sphinx-build -M html docs/source docs/build + $ sphinx-build -M html docs/source docs/build Rendered documentation can be found in "docs/build/html". \ No newline at end of file