readme.rst

Mon, 06 Feb 2017 14:02:20 +0200

author
Iannis <ulalume3@yahoo.com>
date
Mon, 06 Feb 2017 14:02:20 +0200
changeset 99
c6855e46c311
parent 12
3171dc8d75e7
permissions
-rw-r--r--

Move format related files to new dir.

Quick start
===========
* Install Python 2.7
* Install setup tools : http://pypi.python.org/pypi/setuptools
* Install sphinx by running::

   easy_install Sphinx

* Go into the documentation directory and run::

   make html

to generate an html version of the documentation or

   make latexpdf

to generate a PDF document.

Resources
=========

Sphinx main page:

http://sphinx.pocoo.org

Tutorial:

http://sphinx.pocoo.org/tutorial.html

Restructured text:

http://sphinx.pocoo.org/rest.html

Customising sphinx tutorial:

http://matplotlib.sourceforge.net/sampledoc/

mercurial