From 59c84b4391f219c1aff1d4cd12c96712445d8a4e Mon Sep 17 00:00:00 2001 From: Carl Meyer Date: Fri, 19 Nov 2010 16:10:23 +0000 Subject: [PATCH] Bumped documentation-building requirements to Sphinx 1.0.2 and Pygments 1.1. The use of 'console' highlight in staticfiles docs requires Pygments 1.1. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14624 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/internals/documentation.txt | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/internals/documentation.txt b/docs/internals/documentation.txt index 36270eafb7..a0dd17fbc2 100644 --- a/docs/internals/documentation.txt +++ b/docs/internals/documentation.txt @@ -15,8 +15,12 @@ Sphinx -- ``easy_install Sphinx`` should do the trick. .. note:: - The Django documentation can be generated with Sphinx version 0.6 or - newer, but we recommend using Sphinx 1.0.2 or newer. + Building the Django documentation requires Sphinx 1.0.2 or newer. Sphinx + also requires the Pygments__ library for syntax highlighting; building the + Django documentation requires Pygments 1.1 or newer (a new-enough version + should automatically be installed along with Sphinx). + +__ http://pygments.org Then, building the HTML is easy; just ``make html`` from the ``docs`` directory.