summaryrefslogtreecommitdiff
path: root/docs/internals
diff options
context:
space:
mode:
authorJannis Leidel <jannis@leidel.info>2010-07-25 20:58:58 +0000
committerJannis Leidel <jannis@leidel.info>2010-07-25 20:58:58 +0000
commit953f4be2014f0820a887d99a0d991618a6102c63 (patch)
treea4c744ff1ef89cfdd90e684721170d5656e44dc2 /docs/internals
parentacbf74a72131bd3af4d7341a81635ee700b85b0e (diff)
[1.2.X] Fixed #14005 - Removed a few unneeded workarounds in the Sphinx extension. Thanks for the report and patch, Ramiro Morales.
Backport of r13447 from trunk. git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@13448 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/internals')
-rw-r--r--docs/internals/documentation.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/internals/documentation.txt b/docs/internals/documentation.txt
index 81480abf9a..9aa8551266 100644
--- a/docs/internals/documentation.txt
+++ b/docs/internals/documentation.txt
@@ -15,6 +15,11 @@ __ http://docutils.sourceforge.net/
To actually build the documentation locally, you'll currently need to install
Sphinx -- ``easy_install Sphinx`` should do the trick.
+.. note::
+
+ Generation of the Django documentation will work with Sphinx version 0.6
+ or newer, but we recommend going straigh to Sphinx 1.0 or newer.
+
Then, building the html is easy; just ``make html`` from the ``docs`` directory.
To get started contributing, you'll want to read the `ReStructuredText