~a-state-of-mind/+junk/mmclient

« back to all changes in this revision

Viewing changes to docs/index.txt

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

docs/index.txt

 

1

mmclient

 

2

++++++++

 

3

 

 

4

This is the main index page of your documentation. It should be written in

 

5

`reStructuredText format <http://docutils.sourceforge.net/rst.html>`_.

 

6

 

 

7

You can generate your documentation in HTML format by running this command::

 

8

 

 

9

    setup.py pudge

 

10

 

 

11

For this to work you will need to download and install `buildutils`_,

 

12

`pudge`_, and `pygments`_.  The ``pudge`` command is disabled by

 

13

default; to ativate it in your project, run::

 

14

 

 

15

    setup.py addcommand -p buildutils.pudge_command

 

16

 

 

17

.. _buildutils: http://pypi.python.org/pypi/buildutils

 

18

.. _pudge: http://pudge.lesscode.org/

 

19

.. _pygments: http://pygments.org/

Loggerhead is a web-based interface for Breezy
Version: 2.0.1