Mercurial > kallithea

annotate docs/index.txt @ 148:d928d5f0a251

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adde raw file to routes, and refactoring updated link to raw file at file source template
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 11 May 2010 22:23:16 +0200
parents 564e40829f80
children 1e757ac98988
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
1 pylons_app
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/