Skip to content

Commit

Permalink
Edits to maintenance/index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
oleksandr-pavlyk committed Feb 21, 2024
1 parent 8d9f2e9 commit b7c5b5b
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions docs/source/maintenance/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,41 @@ clone it:
.. code-block::
:caption: How to clone the repo
git clone https://github.com/<fork-org>/mkl_random.git
git clone https://github.com/<fork-org>/mkl_random.git
A working compiler is needed build :mod:`mkl_random`.
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=</path/to/mkl>
python setup.py develop
$ export MKLROOT=</path/to/mkl>
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".

0 comments on commit b7c5b5b

Please sign in to comment.