Browse files

Added a README for building offline HTML docs.

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 57f4945 commit 4eec036ab3dea211af209d1bd0bdac8955269aaa @spookylukey spookylukey committed Nov 6, 2010
Showing with 19 additions and 0 deletions.
  1. +2 −0 README
  2. +17 −0 docs/README
@@ -17,6 +17,8 @@ how we recommend you read the docs:
next; from there you can jump to the HOWTOs (in docs/howto) for specific
problems, and check out the reference (docs/ref) for gory details.
+ * See docs/README for instructions on building an HTML version of the docs.
Docs are updated rigorously. If you find any problems in the docs, or think they
should be clarified in any way, please take 30 seconds to fill out a ticket
17 docs/README
@@ -0,0 +1,17 @@
+The documentation in this tree is in plain text files and can be viewed using
+any text file viewer.
+Technically speaking, it uses ReST (reStructuredText) [1], and the Sphinx
+documentation system [2]. This allows it to be built into other forms for
+easier viewing and browsing.
+To create an HTML version of the docs on a Unix machine (Linux or Mac):
+* Install Sphinx (using ``easy_install Sphinx`` or some other method)
+* In this docs/ directory, type ``make html`` at a shell prompt.
+The documentation in _build/html/index.html can then be viewed in a web browser.

0 comments on commit 4eec036

Please sign in to comment.