Fixed the reusable apps docs to use a rst file extension for the README and follow PEP8 a bit more.
This commit is contained in:
parent
f17aa998be
commit
949b4e9458
|
@ -130,7 +130,7 @@ this. For a small app like polls, this process isn't too difficult.
|
|||
|
||||
2. Move the ``polls`` directory into the ``django-polls`` directory.
|
||||
|
||||
3. Create a file ``django-polls/README.txt`` with the following contents::
|
||||
3. Create a file ``django-polls/README.rst`` with the following contents::
|
||||
|
||||
=====
|
||||
Polls
|
||||
|
@ -178,23 +178,23 @@ Create a file ``django-polls/setup.py`` with the following contents::
|
|||
import os
|
||||
from setuptools import setup
|
||||
|
||||
README = open(os.path.join(os.path.dirname(__file__), 'README.txt')).read()
|
||||
README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
|
||||
|
||||
# allow setup.py to be run from any path
|
||||
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
|
||||
|
||||
setup(
|
||||
name = 'django-polls',
|
||||
version = '0.1',
|
||||
packages = ['polls'],
|
||||
include_package_data = True,
|
||||
license = 'BSD License', # example license
|
||||
description = 'A simple Django app to conduct Web-based polls.',
|
||||
long_description = README,
|
||||
url = 'http://www.example.com/',
|
||||
author = 'Your Name',
|
||||
author_email = 'yourname@example.com',
|
||||
classifiers = [
|
||||
name='django-polls',
|
||||
version='0.1',
|
||||
packages=['polls'],
|
||||
include_package_data=True,
|
||||
license='BSD License', # example license
|
||||
description='A simple Django app to conduct Web-based polls.',
|
||||
long_description=README,
|
||||
url='http://www.example.com/',
|
||||
author='Your Name',
|
||||
author_email='yourname@example.com',
|
||||
classifiers=[
|
||||
'Environment :: Web Environment',
|
||||
'Framework :: Django',
|
||||
'Intended Audience :: Developers',
|
||||
|
@ -217,10 +217,12 @@ Create a file ``django-polls/setup.py`` with the following contents::
|
|||
6. Only Python modules and packages are included in the package by default. To
|
||||
include additional files, we'll need to create a ``MANIFEST.in`` file. The
|
||||
distribute docs referred to in the previous step discuss this file in more
|
||||
details. To include the templates and our LICENSE file, create a file
|
||||
``django-polls/MANIFEST.in`` with the following contents::
|
||||
details. To include the templates, the ``README.rst`` and our ``LICENSE``
|
||||
file, create a file ``django-polls/MANIFEST.in`` with the following
|
||||
contents::
|
||||
|
||||
include LICENSE
|
||||
include README.rst
|
||||
recursive-include polls/templates *
|
||||
|
||||
7. It's optional, but recommended, to include detailed documentation with your
|
||||
|
|
Loading…
Reference in New Issue