Permalink
Browse files

added docs in line with Pinax doc style; added support for ghettoq; m…

…ade most settings have sane defaults
  • Loading branch information...
1 parent ffc520e commit 942a7cf79bbee92095e60ac4a2812d824e79e9ea @paltman paltman committed Jun 13, 2010
View
@@ -0,0 +1,130 @@
+# 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) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+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 " 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-pdf.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-pdf.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-pdf"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-pdf"
+ @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: latex
+ $(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."
+
+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."
View
@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+
+import sys, os
+sys.path.append(os.path.abspath(os.curdir))
+sys.path.append(os.path.abspath(os.pardir))
+os.environ["DJANGO_SETTINGS_MODULE"] = "settings"
+
+extensions = ['sphinx.ext.autodoc']
+templates_path = ['_templates']
+source_suffix = '.txt'
+master_doc = 'index'
+
+project = u'django-pdf'
+copyright = u'2010, Patrick Altman'
+version = '1.0.0'
+release = '1.0.0'
+
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+html_theme = 'default'
+html_static_path = ['_static']
+html_last_updated_fmt = '%b %d, %Y'
+htmlhelp_basename = 'django-pdfdoc'
+
+latex_documents = [
+ ('index', 'django-pdf.tex', u'django-pdf Documentation',
+ u'Patrick Altman', 'manual'),
+]
+
+man_pages = [
+ ('index', 'django-pdf', u'django-pdf Documentation',
+ [u'Patrick Altman'], 1)
+]
View
@@ -0,0 +1,58 @@
+.. _ref-django-pdf-gettingstarted:
+
+
+===============
+Getting started
+===============
+
+This document is designed to get you up and running with ``django-pdf``...
+
+
+Prerequisites
+=============
+
+These are the requirements to run ``django-pdf``:
+
+ * Python **2.4+** (Python 3.x is **not** supported yet)
+ * Django **1.2+**
+ * boto
+ * celery
+ * ghettomq (This is optional, in case you don't want to use RabbitMQ)
+
+These dependencies should be added to your ``requirements/project.txt`` file
+and installed using pip_. For example::
+
+ pip install -r requirements/project.txt
+
+In addition to the software requirements outlined above, you will need an
+`Amazon AWS`_ account that has EC2 services enabled to be able to run background
+jobs on the cloud.
+
+
+Installation
+============
+
+Add ``pdf`` to your ``INSTALLED_APPS``:
+
+.. code-block:: python
+
+ INSTALLED_APPS = [
+ # ...
+ "ghettoq",
+ "celery",
+ "pdf",
+ ]
+
+Hook up ``pdf`` to your URLconf:
+
+.. code-block:: python
+
+ urlpatterns = patterns("",
+ # ...
+ url(r"^docs/", include("pdf.urls"))
+ )
+
+
+
+.. _pip: http://pip.openplans.org/
+.. _Amazon AWS: http://aws.amazon.com/
View
@@ -0,0 +1,26 @@
+.. _ref-django-pdf-index:
+
+==========
+django-pdf
+==========
+
+``django-pdf`` is an app that provides the ability to take user uploads of PDF
+documents that are then subsequently stored on S3 and converted to single
+png images for each page in the PDF.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ gettingstarted
+ reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
View
No changes.
View
No changes.
View
@@ -1,20 +0,0 @@
-django-pdf
-==========
-
-`django-pdf` is an app that provides the ability to take user uploads of PDF
-documents that are then subsequently stored on S3 and converted to single
-png images for each page in the PDF.
-
-Non Python Requirements
------------------------
-
-In order to accomplish this processing, Amazon AWS is used via the `boto`
-library. In addition, to provide a better user experience, celery/rabbitmq are
-used to facilitate background transfer of PDF uploads to S3 instead of holding
-the request/response cycle open during transfer.
-
-`boto` and `celery` will be installed through normal pip processing of the
-included requirements.txt file. However, you will need to install rabbitmq
-in order for uploads to get processed.
-
-In addition, you will need an Amazon AWS account with access to EC2 enabled.
Oops, something went wrong.

0 comments on commit 942a7cf

Please sign in to comment.