Revise readme.

This commit is contained in:
Prateek Singh Paudel 2012-10-04 00:48:18 +05:45
parent f6e2fbc935
commit 5be55b0b64

View File

@ -1,22 +1,19 @@
Generate Documentation
----------------------
======================
Requirements
++++++++++++
------------
To generate documentation you need to install:
- Python 2.x >= 2.5
- jinja2 (http://jinja.pocoo.org/2/)
- docutils (http://docutils.sourceforge.net/)
- compass (http://compass-style.org/)
- compass-960-plugin (http://github.com/chriseppstein/compass-960-plugin)
Generate
++++++++
- Sphinx (http://sphinx.pocoo.org/)
Generate html
-------------
::
$ ./buildweb.py
$ make html
Have a look in the file.py for configuration details.
The command generates html document inside ``build/html`` dir.