README.rst 675 Bytes
Newer Older
1 2
Prerequisite packages

anoop chandran's avatar
anoop chandran committed
3 4
Base packages::

5
  sphinx
anoop chandran's avatar
anoop chandran committed
6 7 8

Optional packages::

9
  sphinx_rtd_theme
anoop chandran's avatar
anoop chandran committed
10
  latex (for pdf creation)
11

anoop chandran's avatar
anoop chandran committed
12 13 14 15 16
To build the documentation in sphinx, from this folder run::

  make html

This generates a html documentation tree under spex-docs/build
17 18

::
anoop chandran's avatar
anoop chandran committed
19 20 21

  make latexpdf

Anoop Chandran's avatar
Anoop Chandran committed
22
This generates a pdf documentation tree under spex-docs/build
anoop chandran's avatar
anoop chandran committed
23 24 25 26 27 28 29 30 31 32

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