index.rst 605 Bytes
Newer Older
Philipp Arras's avatar
Philipp Arras committed
1
2
3
4
5
6
7
Contributing to NIFTy
=====================


Coding conventions
------------------

Philipp Arras's avatar
Typo    
Philipp Arras committed
8
9
We do not use pure Python `assert` statements in production code. They are not
guaranteed to by executed by Python and can be turned off by the user
Philipp Arras's avatar
Philipp Arras committed
10
11
12
13
14
15
16
17
18
19
(`python -O` in cPython). As an alternative use `ift.myassert`.


Build the documentation
-----------------------

To build the documentation from source, install `sphinx
<https://www.sphinx-doc.org/en/stable/index.html>`_ and the `pydata sphinx theme
<https://github.com/readthedocs/sphinx_rtd_theme>`_ on your system and run

Philipp Arras's avatar
Typo    
Philipp Arras committed
20
21
22
.. code-block:: sh

   sh docs/generate.sh