Ticket #12975: 0001-Changed-references-to-reST-and-reStructuredText-for-.patch

File 0001-Changed-references-to-reST-and-reStructuredText-for-.patch, 5.3 KB (added by Nathaniel Whiteinge, 14 years ago)

Consistency patch for references to reStructuredText.

  • django/contrib/markup/templatetags/markup.py 

    From 87a7faf2cbcbd0d44f7514596c98a69363e8d807 Mon Sep 17 00:00:00 2001
From: Seth House <seth@eseth.com>
Date: Sun, 27 Jun 2010 11:30:20 -0600
Subject: [PATCH 1/2] Changed references to reST and reStructuredText for consistency.

Even though there are multiple abbreviations that are considered
"correct" by the docutils project, Django documentation should chose one
and stick with it.
---
 django/contrib/markup/templatetags/markup.py |    2 +-
 docs/faq/general.txt                         |    4 ++--
 docs/internals/contributing.txt              |    4 ++--
 docs/internals/documentation.txt             |    2 +-
 docs/ref/contrib/index.txt                   |    4 ++--
 docs/ref/templates/builtins.txt              |    2 +-
 6 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/django/contrib/markup/templatetags/markup.py b/django/contrib/markup/templatetags/markup.py
index 912655f..7cdc04c 100644
    a b markup syntaxes to HTML; currently there is support for:  
    88    * Markdown, which requires the Python-markdown library from
    99      http://www.freewisdom.org/projects/python-markdown
    1010
    11     * ReStructuredText, which requires docutils from http://docutils.sf.net/
     11    * reStructuredText, which requires docutils from http://docutils.sf.net/
    1212"""
    1313
    1414from django import template

  • docs/faq/general.txt 

    diff --git a/docs/faq/general.txt b/docs/faq/general.txt
index 1181d26..d6b3414 100644
    a b How can I download the Django documentation to read it offline?  
    169169---------------------------------------------------------------
    170170
    171171The Django docs are available in the ``docs`` directory of each Django tarball
    172 release. These docs are in ReST (ReStructured Text) format, and each text file
     172release. These docs are in reST (reStructuredText) format, and each text file
    173173corresponds to a Web page on the official Django site.
    174174
    175175Because the documentation is `stored in revision control`_, you can browse
    176176documentation changes just like you can browse code changes.
    177177
    178178Technically, the docs on Django's site are generated from the latest development
    179 versions of those ReST documents, so the docs on the Django site may offer more
     179versions of those reST documents, so the docs on the Django site may offer more
    180180information than the docs that come with the latest Django release.
    181181
    182182.. _stored in revision control: http://code.djangoproject.com/browser/django/trunk/docs

  • docs/internals/contributing.txt 

    diff --git a/docs/internals/contributing.txt b/docs/internals/contributing.txt
index c555f20..2aa5dd9 100644
    a b There's a full page of information about the :ref:`Django documentation  
    698698system <internals-documentation>` that you should read prior to working on the
    699699documentation.
    700700
    701 Guidelines for ReST files
     701Guidelines for reST files
    702702-------------------------
    703703
    704 These guidelines regulate the format of our ReST documentation:
     704These guidelines regulate the format of our reST documentation:
    705705
    706706    * In section titles, capitalize only initial words and proper nouns.
    707707

  • docs/internals/documentation.txt 

    diff --git a/docs/internals/documentation.txt b/docs/internals/documentation.txt
index 81480ab..9cc5c97 100644
    a b Sphinx -- ``easy_install Sphinx`` should do the trick.  
    1717
    1818Then, building the html is easy; just ``make html`` from the ``docs`` directory.
    1919
    20 To get started contributing, you'll want to read the `ReStructuredText
     20To get started contributing, you'll want to read the `reStructuredText
    2121Primer`__. After that, you'll want to read about the `Sphinx-specific markup`__
    2222that's used to manage metadata, indexing, and cross-references.
    2323

  • docs/ref/contrib/index.txt 

    diff --git a/docs/ref/contrib/index.txt b/docs/ref/contrib/index.txt
index bb470e3..45b2c4e 100644
    a b A collection of template filters that implement common markup languages:  
    145145
    146146    * ``textile`` -- implements `Textile`_ -- requires `PyTextile`_
    147147    * ``markdown`` -- implements `Markdown`_ -- requires `Python-markdown`_
    148     * ``restructuredtext`` -- implements `ReST (ReStructured Text)`_
     148    * ``restructuredtext`` -- implements `reST (reStructuredText)`_
    149149      -- requires `doc-utils`_
    150150
    151151In each case, the filter expects formatted markup as a string and returns a
    … … For more documentation, read the source code in  
    160160
    161161.. _Textile: http://en.wikipedia.org/wiki/Textile_%28markup_language%29
    162162.. _Markdown: http://en.wikipedia.org/wiki/Markdown
    163 .. _ReST (ReStructured Text): http://en.wikipedia.org/wiki/ReStructuredText
     163.. _reST (reStructuredText): http://en.wikipedia.org/wiki/ReStructuredText
    164164.. _PyTextile: http://loopcore.com/python-textile/
    165165.. _Python-markdown: http://www.freewisdom.org/projects/python-markdown
    166166.. _doc-utils: http://docutils.sf.net/

  • docs/ref/templates/builtins.txt 

    diff --git a/docs/ref/templates/builtins.txt b/docs/ref/templates/builtins.txt
index 002aa3f..394d568 100644
    a b A collection of template filters that implement these common markup languages:  
    20672067
    20682068    * Textile
    20692069    * Markdown
    2070     * ReST (ReStructured Text)
     2070    * reST (reStructuredText)
    20712071
    20722072See :ref:`ref-contrib-markup`.
    20732073
Back to Top