Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

[1.5.x] Fixed the reusable apps docs to use a rst file extension for …

…the README and follow PEP8 a bit more.

Backport of 949b4e9 from master.
  • Loading branch information...
commit 399ceaab96d3b9724a63faea13d7fc153325516a 1 parent da89c7b
Jannis Leidel authored April 24, 2013

Showing 1 changed file with 17 additions and 15 deletions. Show diff stats Hide diff stats

  1. 32  docs/intro/reusable-apps.txt
32  docs/intro/reusable-apps.txt
@@ -129,7 +129,7 @@ this. For a small app like polls, this process isn't too difficult.
129 129
 
130 130
 2. Move the ``polls`` directory into the ``django-polls`` directory.
131 131
 
132  
-3. Create a file ``django-polls/README.txt`` with the following contents::
  132
+3. Create a file ``django-polls/README.rst`` with the following contents::
133 133
 
134 134
     =====
135 135
     Polls
@@ -177,23 +177,23 @@ Create a file ``django-polls/setup.py`` with the following contents::
177 177
     import os
178 178
     from setuptools import setup
179 179
 
180  
-    README = open(os.path.join(os.path.dirname(__file__), 'README.txt')).read()
  180
+    README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
181 181
 
182 182
     # allow setup.py to be run from any path
183 183
     os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
184 184
 
185 185
     setup(
186  
-        name = 'django-polls',
187  
-        version = '0.1',
188  
-        packages = ['polls'],
189  
-        include_package_data = True,
190  
-        license = 'BSD License', # example license
191  
-        description = 'A simple Django app to conduct Web-based polls.',
192  
-        long_description = README,
193  
-        url = 'http://www.example.com/',
194  
-        author = 'Your Name',
195  
-        author_email = 'yourname@example.com',
196  
-        classifiers = [
  186
+        name='django-polls',
  187
+        version='0.1',
  188
+        packages=['polls'],
  189
+        include_package_data=True,
  190
+        license='BSD License',  # example license
  191
+        description='A simple Django app to conduct Web-based polls.',
  192
+        long_description=README,
  193
+        url='http://www.example.com/',
  194
+        author='Your Name',
  195
+        author_email='yourname@example.com',
  196
+        classifiers=[
197 197
             'Environment :: Web Environment',
198 198
             'Framework :: Django',
199 199
             'Intended Audience :: Developers',
@@ -216,10 +216,12 @@ Create a file ``django-polls/setup.py`` with the following contents::
216 216
 6. Only Python modules and packages are included in the package by default. To
217 217
    include additional files, we'll need to create a ``MANIFEST.in`` file. The
218 218
    distribute docs referred to in the previous step discuss this file in more
219  
-   details. To include the templates and our LICENSE file, create a file
220  
-   ``django-polls/MANIFEST.in`` with the following contents::
  219
+   details. To include the templates, the ``README.rst`` and our ``LICENSE``
  220
+   file, create a file ``django-polls/MANIFEST.in`` with the following
  221
+   contents::
221 222
 
222 223
     include LICENSE
  224
+    include README.rst
223 225
     recursive-include polls/templates *
224 226
 
225 227
 7. It's optional, but recommended, to include detailed documentation with your

0 notes on commit 399ceaa

Please sign in to comment.
Something went wrong with that request. Please try again.