Skip to content

Commit 949b4e9

Browse files
committed
Fixed the reusable apps docs to use a rst file extension for the README and follow PEP8 a bit more.
1 parent f17aa99 commit 949b4e9

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

docs/intro/reusable-apps.txt

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ this. For a small app like polls, this process isn't too difficult.
130130

131131
2. Move the ``polls`` directory into the ``django-polls`` directory.
132132

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::
134134

135135
=====
136136
Polls
@@ -178,23 +178,23 @@ Create a file ``django-polls/setup.py`` with the following contents::
178178
import os
179179
from setuptools import setup
180180

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()
182182

183183
# allow setup.py to be run from any path
184184
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
185185

186186
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 = '[email protected]',
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='[email protected]',
197+
classifiers=[
198198
'Environment :: Web Environment',
199199
'Framework :: Django',
200200
'Intended Audience :: Developers',
@@ -217,10 +217,12 @@ Create a file ``django-polls/setup.py`` with the following contents::
217217
6. Only Python modules and packages are included in the package by default. To
218218
include additional files, we'll need to create a ``MANIFEST.in`` file. The
219219
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::
222223

223224
include LICENSE
225+
include README.rst
224226
recursive-include polls/templates *
225227

226228
7. It's optional, but recommended, to include detailed documentation with your

0 commit comments

Comments
 (0)