Commit 792aca7e authored by anoop chandran's avatar anoop chandran

add Readme description

parent cae07731
To build the documentation in sphinx, from this folder run::
make html
This generates a html documentation tree under spex-docs/build
::
make latexpdf
This generates a html documentation tree under spex-docs/build
You can browse to ``spex-docs/build/html/index.html`` to see the documentation in html format.
If you received a distribution file, you should already find the compiled documentation in ``spex-docs/build/html/index.html``
.. note:: For a nicer html format, install the Read The Docs theme, using
::
pip install sphinx_rtd_theme
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment