aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README7
1 files changed, 4 insertions, 3 deletions
diff --git a/README b/README
index 4cdf66f..f3839cd 100644
--- a/README
+++ b/README
@@ -110,9 +110,10 @@ Just point your web browser at the file
build/html/index.html
-It corresponds to the Sphinx file
-
- source/index.rst
+For the most poart, the file build/html/foo.html is built from
+source/foo.rst. (The index is an exception, because we needed to
+hand-hack the HTML to get the "Contents at a Glance" section to look
+nice).
Read more about Sphinx and use the existing docs source as an example
when writing yours. The directory tmpl/ contains template ReST files