added documentation writing guidelines

mapnik · Sep 26, 2010 · 305c38f · 305c38f
1 parent 17f886a
commit 305c38f
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/documentation_guidelines.rst b/documentation_guidelines.rst
@@ -0,0 +1,30 @@
+********************************
+Documentation writing guidelines
+********************************
+
+* Text width should not be more then **80** characters per line.
+* Following structure should be used: ::
+
+   ==========
+   Main parts
+   ==========   
+
+   ********
+   Chapters
+   ********
+
+   Sections
+   ========
+
+   subsections
+   -----------
+
+   subsubsections
+   ^^^^^^^^^^^^^^
+
+   paragraphs
+   """"""""""
+
+
+
+   
diff --git a/index.rst b/index.rst
@@ -21,8 +21,7 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
-   :numbered:
+   :maxdepth: 1
 
    about_mapnik.rst
    Getting Started <getting_started.rst>
@@ -38,3 +37,13 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`search`
 
+
+================================
+Documentation writing guidelines
+================================
+
+.. toctree::
+   :maxdepth: 1
+
+   documentation_guidelines.rst
+