Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity

[1.5.x] Fixed the reusable apps docs to use a rst file extension for the README and follow PEP8 a bit more.

Browse Source 
Backport of 949b4e94588e73067f64b5b6d22e569a105baaf7 from master.
This commit is contained in:
Jannis Leidel 2013-04-24 09:27:03 +02:00
parent da89c7bbc0
commit 399ceaab96
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/intro/reusable-apps.txt
View File

@ -129,7 +129,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
@ -177,7 +177,7 @@ 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)))
@ -216,10 +216,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