Added a README for building offline HTML docs.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14478 bcc190cf-cafb-0310-a4f2-bffc1f526a37
spookylukey · Nov 6, 2010 · 4eec036 · 4eec036
1 parent 57f4945
commit 4eec036
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/README b/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
 here:

diff --git a/docs/README b/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.
+
+[1] http://docutils.sourceforge.net/rst.html
+[2] http://sphinx.pocoo.org/