diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2010-08-09 21:22:37 +0000 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2010-08-09 21:22:37 +0000 |
| commit | 6001ba016a3db4701d56abc6d30868d4e5d88dbf (patch) | |
| tree | 7a42c57d802484300c2384d3cd3a968de1804383 /docs/internals/documentation.txt | |
| parent | c7bd48cb9f645e5ff07d1e68b86130e3bb2b043f (diff) | |
| download | django-soc2010/query-refactor.tar.gz | |
[soc2010/query-refactor] Merged up to trunk r13556, resolved merge conflictsarchive/soc2010/query-refactorsoc2010/query-refactor
git-svn-id: http://code.djangoproject.com/svn/django/branches/soc2010/query-refactor@13565 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/internals/documentation.txt')
| -rw-r--r-- | docs/internals/documentation.txt | 5 |
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 |