Files
django-anymail/docs/index.rst
medmunds ea72b2d790 DRY up duplicate content in the readme and docs index page.
* Don't maintain similar overview in README.rst and docs/index.rst -- instead just include relevant portions of readme in the docs
* Patch up README version numbers and doc links in setup.py long_description to freeze them to the version being setup
* Suppress the Travis build status indicator in the docs and PyPI, since it can't be frozen to the specific version in question
2013-03-04 20:25:10 -08:00

46 lines
1.2 KiB
ReStructuredText

.. Djrill documentation master file, created by
sphinx-quickstart on Sat Mar 2 13:07:34 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. Incorporate the shared-intro section from the root README:
.. include:: ../README.rst
:start-after: _shared-intro:
:end-before: END shared-intro
.. Eliminate the README's Travis build status indicator.
(Is there some way we could link to Travis status for the
specific |VERSION| of the app being documented here???)
.. |buildstatus| replace:: \
.. _toc:
Documentation
-------------
.. toctree::
:maxdepth: 2
quickstart
installation
usage/sending_mail
usage/templates
usage/multiple_backends
contributing
history
Thanks
------
Thanks to the MailChimp team for asking us to build this nifty little app, and to all of Djrill's
:doc:`contributors <contributing>`. Also thanks to James Socol on Github for his django-adminplus_
library that got us off on the right foot for the custom admin views.
Oh, and, of course, Kenneth Reitz for the awesome requests_ library.
.. _requests: http://docs.python-requests.org
.. _django-adminplus: https://github.com/jsocol/django-adminplus