Fixed #13333 -- Corrected typo in whatsnew docs. Thanks to cicatrix1 for the report.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@13195 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Russell Keith-Magee 2010-05-10 11:35:43 +00:00
parent 13532eb9ea
commit d73eb089f2
1 changed files with 15 additions and 15 deletions

View File

@ -41,14 +41,14 @@ different needs:
to Django -- or to web development in general. It doesn't cover anything to Django -- or to web development in general. It doesn't cover anything
in depth, but instead gives a high-level overview of how developing in in depth, but instead gives a high-level overview of how developing in
Django "feels". Django "feels".
* The :ref:`topic guides <topics-index>`, on the other hand, dive deep into * The :ref:`topic guides <topics-index>`, on the other hand, dive deep into
individual parts of Django. There are complete guides to Django's individual parts of Django. There are complete guides to Django's
:ref:`model system <topics-db-index>`, :ref:`template engine :ref:`model system <topics-db-index>`, :ref:`template engine
<topics-templates>`, :ref:`forms framework <topics-forms-index>`, and much <topics-templates>`, :ref:`forms framework <topics-forms-index>`, and much
more. more.
This is probably where you'll want to spent most of your time; if you work This is probably where you'll want to spend most of your time; if you work
your way through these guides you should come out knowing pretty much your way through these guides you should come out knowing pretty much
everything there is to know about Django. everything there is to know about Django.
@ -67,14 +67,14 @@ different needs:
methods, and modules are kept in the :ref:`reference <ref-index>`. This is methods, and modules are kept in the :ref:`reference <ref-index>`. This is
where you'll turn to find the details of a particular function or where you'll turn to find the details of a particular function or
whathaveyou. whathaveyou.
* Finally, there's some "specialized" documentation not usually relevant to * Finally, there's some "specialized" documentation not usually relevant to
most developers. This includes the :ref:`release notes <releases-index>`, most developers. This includes the :ref:`release notes <releases-index>`,
:ref:`documentation of obsolete features <obsolete-index>`, :ref:`documentation of obsolete features <obsolete-index>`,
:ref:`internals documentation <internals-index>` for those who want to add :ref:`internals documentation <internals-index>` for those who want to add
code to Django itself, and a :ref:`few other things that simply don't fit code to Django itself, and a :ref:`few other things that simply don't fit
elsewhere <misc-index>`. elsewhere <misc-index>`.
How documentation is updated How documentation is updated
============================ ============================
@ -160,7 +160,7 @@ Django document:
.. code-block:: bash .. code-block:: bash
$ grep -r max_length /path/to/django/docs/ $ grep -r max_length /path/to/django/docs/
As HTML, locally As HTML, locally
---------------- ----------------
@ -170,29 +170,29 @@ You can get a local copy of the HTML documentation following a few easy steps:
plain text to HTML. You'll need to install Sphinx by either downloading plain text to HTML. You'll need to install Sphinx by either downloading
and installing the package from the Sphinx website, or by Python's and installing the package from the Sphinx website, or by Python's
``easy_install``: ``easy_install``:
.. code-block:: bash .. code-block:: bash
$ easy_install Sphinx $ easy_install Sphinx
* Then, just use the included ``Makefile`` to turn the documentation into * Then, just use the included ``Makefile`` to turn the documentation into
HTML: HTML:
.. code-block:: bash .. code-block:: bash
$ cd path/to/django/docs $ cd path/to/django/docs
$ make html $ make html
You'll need `GNU Make`__ installed for this. You'll need `GNU Make`__ installed for this.
* The HTML documentation will be placed in ``docs/_build/html``. * The HTML documentation will be placed in ``docs/_build/html``.
.. warning:: .. warning::
At the time of this writing, Django's using a version of Sphinx not At the time of this writing, Django's using a version of Sphinx not
yet released, so you'll currently need to install Sphinx from the yet released, so you'll currently need to install Sphinx from the
source. We'll fix this shortly. source. We'll fix this shortly.
__ http://sphinx.pocoo.org/ __ http://sphinx.pocoo.org/
__ http://www.gnu.org/software/make/ __ http://www.gnu.org/software/make/