Permalink
Browse files

Added sphinx documentation

  • Loading branch information...
1 parent ad79d6f commit 302148e64956b41bb809157ba889f3e8935174c7 @nabucosound committed Apr 26, 2012
Showing with 3,913 additions and 17 deletions.
  1. +6 −17 README.rst
  2. +153 −0 docs/Makefile
  3. BIN docs/_build/doctrees/environment.pickle
  4. BIN docs/_build/doctrees/index.doctree
  5. BIN docs/_build/doctrees/installation.doctree
  6. +4 −0 docs/_build/html/.buildinfo
  7. +20 −0 docs/_build/html/_sources/index.txt
  8. +22 −0 docs/_build/html/_sources/installation.txt
  9. BIN docs/_build/html/_static/ajax-loader.gif
  10. +540 −0 docs/_build/html/_static/basic.css
  11. BIN docs/_build/html/_static/comment-bright.png
  12. BIN docs/_build/html/_static/comment-close.png
  13. BIN docs/_build/html/_static/comment.png
  14. +256 −0 docs/_build/html/_static/default.css
  15. +247 −0 docs/_build/html/_static/doctools.js
  16. BIN docs/_build/html/_static/down-pressed.png
  17. BIN docs/_build/html/_static/down.png
  18. BIN docs/_build/html/_static/file.png
  19. +154 −0 docs/_build/html/_static/jquery.js
  20. BIN docs/_build/html/_static/minus.png
  21. BIN docs/_build/html/_static/plus.png
  22. +62 −0 docs/_build/html/_static/pygments.css
  23. +560 −0 docs/_build/html/_static/searchtools.js
  24. +151 −0 docs/_build/html/_static/sidebar.js
  25. +23 −0 docs/_build/html/_static/underscore.js
  26. BIN docs/_build/html/_static/up-pressed.png
  27. BIN docs/_build/html/_static/up.png
  28. +808 −0 docs/_build/html/_static/websupport.js
  29. +95 −0 docs/_build/html/genindex.html
  30. +115 −0 docs/_build/html/index.html
  31. +123 −0 docs/_build/html/installation.html
  32. BIN docs/_build/html/objects.inv
  33. +99 −0 docs/_build/html/search.html
  34. +1 −0 docs/_build/html/searchindex.js
  35. +242 −0 docs/conf.py
  36. +20 −0 docs/index.rst
  37. +22 −0 docs/installation.rst
  38. +190 −0 docs/make.bat
View
@@ -11,22 +11,11 @@ This simple Django application is made to be used for trivial newsletter
supply the raw content (both plain text and HTML versions) to be delivered.
Subscribers (**subscribers**) will then receive the emails you send.
-Installation
-============
+Documentation
+=============
-#. Install the latest version::
-
- pip install django-propaganda
-
-#. Add ``propaganda`` to your ``INSTALLED_APPS`` setting.
-
-#. If you use South for migration management (you should!) just run the
- migrations::
-
- python manage.py migrate propaganda
-
-#. Otherwise, update your database the Django standard way (the good old
- ``syncdb```)::
-
- python manage.py syncdb
+Read the latest documentation on the fine `Read the docs`_ project for
+installation, configuration and customization instructions, and also to read
+examples and tutorials about how to use the package in different scenarios.
+.. _`Read the docs`: http://readthedocs.org/docs/django-propaganda/en/latest/
View
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-propaganda.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-propaganda.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/django-propaganda"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-propaganda"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 1f385d06a40a4ac21f02d97fc14fe4fb
+tags: fbb0d17656682115ca4d033fb2f83ba1
@@ -0,0 +1,20 @@
+=================
+django-propaganda
+=================
+
+Hey you, political leader, founder of a new religion or spiritual guru! With
+this application, your acolytes will receive the official organizational
+propaganda pamphlets right into their inboxes. Keep them updated with the Truth!
+
+This simple Django application is made to be used for trivial newsletter
+(**pamphlets**) deliveries with your information (**propaganda**), where you
+supply the raw content (both plain text and HTML versions) to be delivered.
+Subscribers (**subscribers**) will then receive the emails you send.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ installation
+
@@ -0,0 +1,22 @@
+============
+Installation
+============
+
+#. Install the latest version::
+
+ pip install django-propaganda
+
+#. Add ``propaganda`` to your ``INSTALLED_APPS`` setting. One possible method::
+
+ INSTALLED_APPS = INSTALLED_APPS + ('propaganda',)
+
+#. If you use South for migration management (you should!) just run the
+ migrations::
+
+ python manage.py migrate propaganda
+
+#. Otherwise, update your database the Django standard way (the good old
+ ``syncdb``)::
+
+ python manage.py syncdb
+
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.

0 comments on commit 302148e

Please sign in to comment.