Mercurial > kallithea

annotate docs/index.txt @ 547:1e757ac98988

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
renamed project to rhodecode
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 06 Oct 2010 03:18:16 +0200
parents 564e40829f80
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
547
1e757ac98988 renamed project to rhodecode
Marcin Kuzminski <marcin@python-works.com>
parents: 0
diff changeset
1 rhodecode
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
2 ++++++++++
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
3
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
4 This is the main index page of your documentation. It should be written in
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
5 `reStructuredText format <http://docutils.sourceforge.net/rst.html>`_.
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
6
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
7 You can generate your documentation in HTML format by running this command::
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
8
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
9 setup.py pudge
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
10
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
11 For this to work you will need to download and install `buildutils`_,
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
12 `pudge`_, and `pygments`_. The ``pudge`` command is disabled by
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
13 default; to ativate it in your project, run::
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
14
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
15 setup.py addcommand -p buildutils.pudge_command
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
16
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
17 .. _buildutils: http://pypi.python.org/pypi/buildutils
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
18 .. _pudge: http://pudge.lesscode.org/
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
19 .. _pygments: http://pygments.org/