Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Fixed the reusable apps docs to use a rst file extension for the READ…

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

0 notes on commit 949b4e9

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