From b0bb39ffe6861b938113b596c04e86b0de934fcb Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Wed, 15 Jun 2011 12:23:57 -0400 Subject: Add template page for creating libmaple proper API documentation. --- README | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'README') 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. -- cgit v1.2.3