changeset 6:d632bfadc25c

add some short docs about documentation
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Mon, 21 Feb 2011 03:37:27 +0100
parents 4641656b7102
children 164fc219e28d
files docs/devel/development.rst
diffstat 1 files changed, 14 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/docs/devel/development.rst	Mon Feb 21 03:23:04 2011 +0100
+++ b/docs/devel/development.rst	Mon Feb 21 03:37:27 2011 +0100
@@ -209,3 +209,17 @@
 For more information, please read on there: http://pytest.org/ - but keep in
 mind that we currently still use **py.test 1.3.4**.
 
+Documentation
+=============
+We use Sphinx (see http://sphinx.pocoo.org/) and reST markup for documenting
+moin. Documentation reST source code, example files and some other text files
+are located in the `docs/` directory in the source tree.
+
+Creating docs
+-------------
+Sphinx can create all kinds of documentation formats, we'll just list the most
+popular ones below::
+
+    cd docs
+    make html  # create html docs (to browse online or in the filesystem)
+