Skip to content

Commit

Permalink
Fixed #14383 -- Corrected the capitalization of reStructuredText. Tha…
Browse files Browse the repository at this point in the history
…nks to timo for the patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@14017 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
freakboy3742 committed Oct 8, 2010
1 parent 98c6ff3 commit 127a25a
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion django/contrib/markup/templatetags/markup.py
Expand Up @@ -8,7 +8,7 @@
* 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
Expand Down
4 changes: 2 additions & 2 deletions docs/faq/general.txt
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/internals/contributing.txt
Expand Up @@ -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.


Expand Down
2 changes: 1 addition & 1 deletion docs/internals/documentation.txt
Expand Up @@ -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.


Expand Down
6 changes: 3 additions & 3 deletions docs/ref/contrib/markup.txt
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ref/templates/builtins.txt
Expand Up @@ -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>`.


Expand Down

0 comments on commit 127a25a

Please sign in to comment.