Author: lukeplant
Date: 2010-11-06 12:44:26 -0500 (Sat, 06 Nov 2010)
New Revision: 14478
Added:
django/trunk/docs/README
Modified:
django/trunk/README
Log:
Added a README for building offline HTML docs.
Modified: django/trunk/README
===================================================================
--- django/trunk/README 2010-11-06 17:42:21 UTC (rev 14477)
+++ django/trunk/README 2010-11-06 17:44:26 UTC (rev 14478)
@@ -17,6 +17,8 @@
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:
Added: django/trunk/docs/README
===================================================================
--- django/trunk/docs/README (rev 0)
+++ django/trunk/docs/README 2010-11-06 17:44:26 UTC (rev 14478)
@@ -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/
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
