aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcin Kuzminski <none@none>2010-02-18 13:01:57 +0100
committerMarcin Kuzminski <none@none>2010-02-18 13:01:57 +0100
commitee2f692ce7af625e890a335a2ba8d7d908522a2c (patch)
treea4c8e1f6ae070067245be067c1bcf675adfb2ffa /docs
initial commit.
Diffstat (limited to 'docs')
-rw-r--r--docs/index.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/index.txt b/docs/index.txt
new file mode 100644
index 00000000..be457067
--- /dev/null
+++ b/docs/index.txt
@@ -0,0 +1,19 @@
+pylons_app
+++++++++++
+
+This is the main index page of your documentation. It should be written in
+`reStructuredText format <http://docutils.sourceforge.net/rst.html>`_.
+
+You can generate your documentation in HTML format by running this command::
+
+ setup.py pudge
+
+For this to work you will need to download and install `buildutils`_,
+`pudge`_, and `pygments`_. The ``pudge`` command is disabled by
+default; to ativate it in your project, run::
+
+ setup.py addcommand -p buildutils.pudge_command
+
+.. _buildutils: http://pypi.python.org/pypi/buildutils
+.. _pudge: http://pudge.lesscode.org/
+.. _pygments: http://pygments.org/