source: main/multimechanize/trunk/docs/README.rst @ 7605

Last change on this file since 7605 was 7552, checked in by uli, 13 years ago

multimech switched to github and incorporated changes officially we applied locally before. This is an update to stick with the latest source from official repos.

File size: 526 bytes
Line 
1---------------------------------------
2Build the Multi-Mechanize docs/website:
3---------------------------------------
4
5The multi-mechanize documentation/website is built using `Sphinx`_.
6
7.. _Sphinx: http://sphinx.pocoo.org/
8
9To build the docs you need to perform the following tasks:
10
11* Install Sphinx (``$ sudo apt-get install python-sphinx``)
12* From this ``docs`` directory, run: ``$ make html``
13* This will produce HTML documentation in the ``_build/html/`` directory
14* Open ``_build/html/index.html`` with your browser
Note: See TracBrowser for help on using the repository browser.