aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-15 12:23:57 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-15 12:23:57 -0400
commitb0bb39ffe6861b938113b596c04e86b0de934fcb (patch)
treefb99a29f88320126cac4120b1d68706fdcb28a14 /README
parentd407a4eeec837a463bd636fd12daa307c3ea6047 (diff)
downloadlibrambutan-b0bb39ffe6861b938113b596c04e86b0de934fcb.tar.gz
librambutan-b0bb39ffe6861b938113b596c04e86b0de934fcb.zip
Add template page for creating libmaple proper API documentation.
Diffstat (limited to 'README')
-rw-r--r--README6
1 files changed, 4 insertions, 2 deletions
diff --git a/README b/README
index 2ed141b..d5aab21 100644
--- a/README
+++ b/README
@@ -107,8 +107,10 @@ It corresponds to the Sphinx file
source/index.rst
-Read more about Sphinx and chase pointers within the docs source to
-find out more.
+Read more about Sphinx and use the existing docs source as an example
+when writing yours. The directory tmpl/ contains template ReST files
+you should modify when creating a new page, in order to keep the style
+consistent.
The file source/conf.py is the Sphinx configuration file; you can go
read it for more information about our setup.