[1.2.X] Fixed #14383 -- Corrected the capitalization of reStructuredText. Thanks to timo for the patch.
Backport of r14017 from trunk. git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14025 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
5170a12a88
commit
9ad73135c0
|
@ -8,7 +8,7 @@ markup syntaxes to HTML; currently there is support for:
|
||||||
* Markdown, which requires the Python-markdown library from
|
* Markdown, which requires the Python-markdown library from
|
||||||
http://www.freewisdom.org/projects/python-markdown
|
http://www.freewisdom.org/projects/python-markdown
|
||||||
|
|
||||||
* ReStructuredText, which requires docutils from http://docutils.sf.net/
|
* reStructuredText, which requires docutils from http://docutils.sf.net/
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from django import template
|
from django import template
|
||||||
|
|
|
@ -167,14 +167,14 @@ How can I download the Django documentation to read it offline?
|
||||||
---------------------------------------------------------------
|
---------------------------------------------------------------
|
||||||
|
|
||||||
The Django docs are available in the ``docs`` directory of each Django tarball
|
The Django docs are available in the ``docs`` directory of each Django tarball
|
||||||
release. These docs are in ReST (ReStructured Text) format, and each text file
|
release. These docs are in reST (reStructuredText) format, and each text file
|
||||||
corresponds to a Web page on the official Django site.
|
corresponds to a Web page on the official Django site.
|
||||||
|
|
||||||
Because the documentation is `stored in revision control`_, you can browse
|
Because the documentation is `stored in revision control`_, you can browse
|
||||||
documentation changes just like you can browse code changes.
|
documentation changes just like you can browse code changes.
|
||||||
|
|
||||||
Technically, the docs on Django's site are generated from the latest development
|
Technically, the docs on Django's site are generated from the latest development
|
||||||
versions of those ReST documents, so the docs on the Django site may offer more
|
versions of those reST documents, so the docs on the Django site may offer more
|
||||||
information than the docs that come with the latest Django release.
|
information than the docs that come with the latest Django release.
|
||||||
|
|
||||||
.. _stored in revision control: http://code.djangoproject.com/browser/django/trunk/docs
|
.. _stored in revision control: http://code.djangoproject.com/browser/django/trunk/docs
|
||||||
|
|
|
@ -700,10 +700,10 @@ There's a full page of information about the :doc:`Django documentation
|
||||||
system </internals/documentation>` that you should read prior to working on the
|
system </internals/documentation>` that you should read prior to working on the
|
||||||
documentation.
|
documentation.
|
||||||
|
|
||||||
Guidelines for ReST files
|
Guidelines for reST files
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
These guidelines regulate the format of our ReST documentation:
|
These guidelines regulate the format of our reST documentation:
|
||||||
|
|
||||||
* In section titles, capitalize only initial words and proper nouns.
|
* In section titles, capitalize only initial words and proper nouns.
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ Sphinx -- ``easy_install Sphinx`` should do the trick.
|
||||||
|
|
||||||
Then, building the html is easy; just ``make html`` from the ``docs`` directory.
|
Then, building the html is easy; just ``make html`` from the ``docs`` directory.
|
||||||
|
|
||||||
To get started contributing, you'll want to read the `ReStructuredText
|
To get started contributing, you'll want to read the `reStructuredText
|
||||||
Primer`__. After that, you'll want to read about the `Sphinx-specific markup`__
|
Primer`__. After that, you'll want to read about the `Sphinx-specific markup`__
|
||||||
that's used to manage metadata, indexing, and cross-references.
|
that's used to manage metadata, indexing, and cross-references.
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ languages:
|
||||||
|
|
||||||
* ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
|
* ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
|
||||||
* ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
|
* ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
|
||||||
* ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
|
* ``restructuredtext`` -- implements `reST (reStructured Text)`_
|
||||||
-- requires `doc-utils`_
|
-- requires `doc-utils`_
|
||||||
|
|
||||||
In each case, the filter expects formatted markup as a string and
|
In each case, the filter expects formatted markup as a string and
|
||||||
|
@ -26,12 +26,12 @@ For more documentation, read the source code in
|
||||||
|
|
||||||
.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
|
.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
|
||||||
.. _Markdown: http://en.wikipedia.org/wiki/Markdown
|
.. _Markdown: http://en.wikipedia.org/wiki/Markdown
|
||||||
.. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
|
.. _reST (reStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
|
||||||
.. _PyTextile: http://loopcore.com/python-textile/
|
.. _PyTextile: http://loopcore.com/python-textile/
|
||||||
.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
|
.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
|
||||||
.. _doc-utils: http://docutils.sf.net/
|
.. _doc-utils: http://docutils.sf.net/
|
||||||
|
|
||||||
ReStructured Text
|
reStructured Text
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
When using the ``restructuredtext`` markup filter you can define a
|
When using the ``restructuredtext`` markup filter you can define a
|
||||||
|
|
|
@ -2095,7 +2095,7 @@ A collection of template filters that implement these common markup languages:
|
||||||
|
|
||||||
* Textile
|
* Textile
|
||||||
* Markdown
|
* Markdown
|
||||||
* ReST (ReStructured Text)
|
* reST (reStructuredText)
|
||||||
|
|
||||||
See the :doc:`markup documentation </ref/contrib/markup>`.
|
See the :doc:`markup documentation </ref/contrib/markup>`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue