Commits

Stefan Scherfke committed 7c13f6e
  • Participants
  • Parent commits c8bb678
  • Tags v0.3.1

Comments (0)

Files changed (24)

CHANGELOG.txt

-
-Changelog for django-sphinxdoc
-==============================
-
-Version 0.3 – 1010-01-06:
--------------------------
-
-- [NEW] Views for images, sources and object inventory
-
-
-Version 0.2 – 2009-12-30:
--------------------------
-
-- [NEW] Documentation, general index and module index work
-- [NEW] Basic documentation written
-
-
-Version 0.1 – 2009-12-19:
--------------------------
-
-- [NEW] Initial release
+
+Changelog for django-sphinxdoc
+==============================
+
+v0.3 – 1010-01-06:
+------------------
+
+- [NEW] Views for images, sources and object inventory
+
+
+v0.2 – 2009-12-30:
+------------------
+
+- [NEW] Documentation, general index and module index work
+- [NEW] Basic documentation written
+
+
+v0.1 – 2009-12-19:
+------------------
+
+- [NEW] Initial release
-recursive-include sphinxdoc/templates *
+include *.txt
+recursive-include docs *
+recursive-include sphinxdoc/templates *
 <http://code.djangoproject.com/browser/djangoproject.com/djangodocs>`_ and
 makes it more widely usable.
 
-django-sphinxdoc can handle multiple Sphinx projects (called apps from now
+django-sphinxdoc can handle multiple Sphinx projects (called apps from now
 on). It takes the static body of the documentation from the JSON files Sphinx
 creates and embeds them in the content block of your site.
 
 ------------
 
 This app is tested with Django 1.1. It might also work with older versions, but
-I haven’t tested it. 
-`Setuptools <http://pypi.python.org/pypi/setuptools>`_ is required to install 
-this app.
+I haven’t tested it.
 
 There are no other requirements.
 
 If you checked out the repository and always want to use the newest version,
 type::
 
-    python setup.py develop
+    pip install -e path/to/django-sphinxdoc
     
 
 Usage
 -----
 
-Documentation on how to use this app can be found in the *docs/* directory.
+The Documentation can be found in the *docs/* directory or
+`online <http://stefan.sofa-rockers.org/docs/django-sphinxdoc/>`_.

doc/Makefile

-# 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 pickle json htmlhelp qthelp latex 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 "  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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@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."
-
-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-sphinxdoc.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-sphinxdoc.qhc"
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-	      "run these through (pdf)latex."
-
-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."

doc/autobuild.txt

-.. _autobuild:
-
-Auto-build JSON files on ``hg pull/push``
-=========================================
-
-If you use `Mercurial (hg) <http://selenic.com/mercurial/>`_ for the application
-you are documenting, you can automatically call ``sphinx-build`` each time you
-push or pull to the clone on your webserver (the same machine running
-your Django project).
-
-You need two things to accomplish this:
-
-1. A script that performs the build
-2. Make ``hg`` call that script
-
-The build script
-----------------
-
-A good place for the script is the ``.hg/`` directory of your repository on the server. Change to that directory and create a file called ``makedoc``:
-
-.. sourcecode:: bash
-
-    #! /bin/bash
-
-    cd /path/to/your/repo
-    hg up
-    cd /path/to/your/repo/doc
-    make json
-
-Make ``hg`` call that script
-----------------------------
-
-Open ``.hg/hgrc`` in your favorite editor and add the following lines to it:
-
-.. sourcecode:: cfg
-
-    [hooks]
-    changegroup = /path/to/your/repo/.hg/makedoc
-    
-Done
-----
-
-Now, each time the repository is modified via a pull or push command, the
-documentation will be updated automatically.

doc/change_appearance.txt

-.. _change_appearance:
-
-Change your documentation’s appearance
-======================================
-
-The templates for ``django-sphinxdoc`` consist of of three top-level ``div``’s
-with the following classes:
-
-``pagination-top``
-    The upper pagination bar with breadcrumbs and links to the previous and
-    next section.
-    
-``sphinx``
-    The stuff generated by ``Sphinx``.
-    
-``pagination-bottom``
-    Like the upper pagination bar, but also contains the build date.
-    
-The ¶ sign after headings
--------------------------
-
-To only show the headings’ ¶ sign, add something like this to your CSS:
-
-.. sourcecode:: css
-
-    #content .sphinx a.headerlink {
-        font-size: 0.8em; 
-        padding: 0 4px 0 4px; 
-        text-decoration: none; 
-        visibility: hidden;
-    }
-    #content .sphinx *:hover > a.headerlink { visibility: visible; }
-    
-    
-Changing font sizes for headings
---------------------------------
-    
-Another style-problem for your site might be, that the Sphinx stuff starts with
-``h1`` as top level heading, but that your site uses ``h1`` for the site title
-and ``h2`` as top level content heading.
-
-I haven’t found a way to modify Sphinx’ behavior and make it use ``h2``. If you
-won’t change your behavior either, you can just change the font sizes of the
-Sphinx headings, so that Sphinx’ ``h1`` matches your ``h2``, e.g.:
-
-.. sourcecode:: css
-
-    h1 { font-size: 40px; } /* This is your blog title */
-    h2 { font-size: 22px; } /* This is used for page and post titles */
-    h3 { font-size: 18px; }
-    
-    /* Changes for Sphinx */
-    #content .sphinx h1 { font-size: 22px; }
-    #content .sphinx h2 { font-size: 18px; }
-    
-
-Changing the appearance of references and class names
------------------------------------------------------
-
-You can also change the appearance of references of class and method
-descriptions, e.g.:
-
-.. sourcecode:: css
-
-    #content .sphinx a.reference { text-decoration: none; }
-    #content .sphinx a.reference tt.literal {
-        border-bottom-width: 1px; 
-        border-bottom-style: dotted;
-    }
-    #content .sphinx a.reference em { font-style: normal; }
-
-    /* Smaller desc (default was 14px) and bold class name */
-    #content .sphinx .descclassname { font-size: 13px; }
-    #content .sphinx .descname { font-weight: bold; }
-    
-
-Other elements
---------------
-
-It’s very easy to change the style of other elements. Just search for the
-elements and their CSS class names in the HTML output and add them to your CSS
-file. Remember to precede each style definition with ``#content .sphinx`` to
-avoid side effects to non-Sphinx stuff.

doc/conf.py

-# -*- coding: utf-8 -*-
-#
-# django-lastfm documentation build configuration file, created by
-# sphinx-quickstart on Fri Nov 27 10:35:57 2009.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-import sys, os
-# from django.conf import settings
-# settings.configure()
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('.'))
-sys.path.append(os.path.abspath('../'))
-
-# -- General configuration -----------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.txt'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'django-sphinxdoc'
-copyright = u'2009, Stefan Scherfke'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '0.2'
-# The full version, including alpha/beta/rc tags.
-release = '0.2'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'django-sphinxdocdoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'django-sphinxdoc.tex', u'django-sphinxdoc Documentation',
-   u'Stefan Scherfke', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True

doc/index.txt

-.. django-sphinxdoc documentation master file, created by
-   sphinx-quickstart on Fri Nov 27 10:35:57 2009.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to django-sphinxdoc's documentation!
-============================================
-
-Contents:
-
-.. toctree::
-    :maxdepth: 2
-   
-    quickstart
-    autobuild
-    change_appearance
-    ref/index
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

doc/quickstart.txt

-.. _quickstart:
-
-Quickstart Guide
-================
-
-This guide assumes that you already have a `Django
-<http://www.djangoproject.com/>`_ installation up and running. If this is not
-the case, you should work through the `Django tutorial
-<http://docs.djangoproject.com/en/dev/intro/install/#intro-install>`_ first.
-
-
-Installation
-------------
-
-This app requires `Setuptools <http://pypi.python.org/pypi/setuptools>`_ for
-installation.
-
-You can either `download a stable version
-<http://bitbucket.org/scherfke/django-sphinxdoc/downloads/>`_ or use the latest
-version from the `repository <http://bitbucket.org/scherfke/django-sphinxdoc/src/>`_.
-
-If you downloaded the stable version, unpack it and open a terminal. Change to
-the directory that contains *django-sphinxdoc’s* ``setup.py`` and execute it as
-follows:
-
-.. sourcecode:: bash
-
-    $ cd where/you/put/django-sphinxdoc/
-    $ sudo python setup.py install
-    
-If you want the bleeding edge, clone the repository and install it in
-development mode. This will create just a link in your ``site packages`` that
-points to your local repository:
-
-.. sourcecode:: bash
-
-    $ hg clone http://bitbucket.org/scherfke/django-sphinxdoc/
-    $ cd django-sphinxdoc/
-    $ sudo python setup.py develop
-    
-With this done, all you need to do to upgrade your installation of
-*django-sphinxdoc* is to type:
-
-.. sourcecode:: bash
-
-   $ hg pull -u
-
-
-Setup
------
-
-Add ``'sphinxdoc'`` to your ``INSTALLED_APPS`` within your 
-``settings.py`` and add the following line to your project’s ``urls.py``:
-   
-.. sourcecode:: python
-
-    (r'^docs/', include('sphinxdoc.urls')),
-    
-Install the required database table with:
-
-.. sourcecode:: bash
-
-    python manage.py syncdb
-    
-    
-Add an application
-------------------
-
-If you visit your project’s admin panel, you’ll find the new application
-*Sphinxdoc* with the *App* model. If you add a new app, you’ll need to fill
-three form fields:
-
-Name:
-    The name of the documented application
-    
-Slug:
-    A sluggified version of the application name; will be generated
-    automatically
-
-Path:
-    A file system path to the JSON files generated by Sphinx including
-    ``_build/json/``, e.g.: ``/path/to/app/doc/_build/json/``
-
-
-That’s it!
-----------
-
-You can now find the application’s documentation under */docs/<slug>/*.
-
-You may want to read:
-
-* :ref:`autobuild`
-* :ref:`change_appearance`

doc/ref/index.txt

-.. _ref-index:
-
-API-Reference
-=============
-
-.. toctree::
-    :maxdepth: 1
-    
-    templatetags
-    views

doc/ref/templatetags.txt

-.. ref-templatetags:
-
-Template Tags
-=============

doc/ref/views.txt

-.. _ref-views:
-
-Views
-=====
+# 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 pickle json htmlhelp qthelp latex 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 "  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 "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@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."
+
+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-sphinxdoc.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-sphinxdoc.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+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."

docs/autobuild.txt

+.. _autobuild:
+
+Auto-build JSON files on ``hg pull/push``
+=========================================
+
+If you use `Mercurial (hg) <http://selenic.com/mercurial/>`_ for the application
+you are documenting, you can automatically call ``sphinx-build`` each time you
+push or pull to the clone on your webserver (the same machine running
+your Django project).
+
+You need two things to accomplish this:
+
+1. A script that performs the build
+2. Make ``hg`` call that script
+
+The build script
+----------------
+
+A good place for the script is the ``.hg/`` directory of your repository on the server. Change to that directory and create a file called ``makedoc``:
+
+.. sourcecode:: bash
+
+    #! /bin/bash
+
+    cd /path/to/your/repo
+    hg up
+    cd /path/to/your/repo/doc
+    make json
+
+Make ``hg`` call that script
+----------------------------
+
+Open ``.hg/hgrc`` in your favorite editor and add the following lines to it:
+
+.. sourcecode:: cfg
+
+    [hooks]
+    changegroup = /path/to/your/repo/.hg/makedoc
+    
+Done
+----
+
+Now, each time the repository is modified via a pull or push command, the
+documentation will be updated automatically.

docs/change_appearance.txt

+.. _change_appearance:
+
+Change your documentation’s appearance
+======================================
+
+The templates for ``django-sphinxdoc`` consist of of three top-level ``div``’s
+with the following classes:
+
+``pagination-top``
+    The upper pagination bar with breadcrumbs and links to the previous and
+    next section.
+    
+``sphinx``
+    The stuff generated by ``Sphinx``.
+    
+``pagination-bottom``
+    Like the upper pagination bar, but also contains the build date.
+    
+The ¶ sign after headings
+-------------------------
+
+To only show the headings’ ¶ sign, add something like this to your CSS:
+
+.. sourcecode:: css
+
+    #content .sphinx a.headerlink {
+        font-size: 0.8em; 
+        padding: 0 4px 0 4px; 
+        text-decoration: none; 
+        visibility: hidden;
+    }
+    #content .sphinx *:hover > a.headerlink { visibility: visible; }
+    
+    
+Changing font sizes for headings
+--------------------------------
+    
+Another style-problem for your site might be, that the Sphinx stuff starts with
+``h1`` as top level heading, but that your site uses ``h1`` for the site title
+and ``h2`` as top level content heading.
+
+I haven’t found a way to modify Sphinx’ behavior and make it use ``h2``. If you
+won’t change your behavior either, you can just change the font sizes of the
+Sphinx headings, so that Sphinx’ ``h1`` matches your ``h2``, e.g.:
+
+.. sourcecode:: css
+
+    h1 { font-size: 40px; } /* This is your blog title */
+    h2 { font-size: 22px; } /* This is used for page and post titles */
+    h3 { font-size: 18px; }
+    
+    /* Changes for Sphinx */
+    #content .sphinx h1 { font-size: 22px; }
+    #content .sphinx h2 { font-size: 18px; }
+    
+
+Changing the appearance of references and class names
+-----------------------------------------------------
+
+You can also change the appearance of references of class and method
+descriptions, e.g.:
+
+.. sourcecode:: css
+
+    #content .sphinx a.reference { text-decoration: none; }
+    #content .sphinx a.reference tt.literal {
+        border-bottom-width: 1px; 
+        border-bottom-style: dotted;
+    }
+    #content .sphinx a.reference em { font-style: normal; }
+
+    /* Smaller desc (default was 14px) and bold class name */
+    #content .sphinx .descclassname { font-size: 13px; }
+    #content .sphinx .descname { font-weight: bold; }
+    
+
+Other elements
+--------------
+
+It’s very easy to change the style of other elements. Just search for the
+elements and their CSS class names in the HTML output and add them to your CSS
+file. Remember to precede each style definition with ``#content .sphinx`` to
+avoid side effects to non-Sphinx stuff.
+# -*- coding: utf-8 -*-
+#
+# django-lastfm documentation build configuration file, created by
+# sphinx-quickstart on Fri Nov 27 10:35:57 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+# from django.conf import settings
+# settings.configure()
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.append(os.path.abspath('.'))
+sys.path.append(os.path.abspath('../'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-sphinxdoc'
+copyright = u'2009, Stefan Scherfke'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-sphinxdocdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'django-sphinxdoc.tex', u'django-sphinxdoc Documentation',
+   u'Stefan Scherfke', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+.. django-sphinxdoc documentation master file, created by
+   sphinx-quickstart on Fri Nov 27 10:35:57 2009.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to django-sphinxdoc's documentation!
+============================================
+
+Contents:
+
+.. toctree::
+    :maxdepth: 2
+   
+    quickstart
+    autobuild
+    change_appearance
+    ref/index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/quickstart.txt

+.. _quickstart:
+
+Quickstart Guide
+================
+
+This guide assumes that you already have a `Django
+<http://www.djangoproject.com/>`_ installation up and running. If this is not
+the case, you should work through the `Django tutorial
+<http://docs.djangoproject.com/en/dev/intro/install/#intro-install>`_ first.
+
+
+Installation
+------------
+
+This app requires `Setuptools <http://pypi.python.org/pypi/setuptools>`_ for
+installation.
+
+You can either `download a stable version
+<http://bitbucket.org/scherfke/django-sphinxdoc/downloads/>`_ or use the latest
+version from the `repository <http://bitbucket.org/scherfke/django-sphinxdoc/src/>`_.
+
+If you downloaded the stable version, unpack it and open a terminal. Change to
+the directory that contains *django-sphinxdoc’s* ``setup.py`` and execute it as
+follows:
+
+.. sourcecode:: bash
+
+    $ cd where/you/put/django-sphinxdoc/
+    $ sudo python setup.py install
+    
+If you want the bleeding edge, clone the repository and install it in
+development mode. This will create just a link in your ``site packages`` that
+points to your local repository:
+
+.. sourcecode:: bash
+
+    $ hg clone http://bitbucket.org/scherfke/django-sphinxdoc/
+    $ cd django-sphinxdoc/
+    $ sudo python setup.py develop
+    
+With this done, all you need to do to upgrade your installation of
+*django-sphinxdoc* is to type:
+
+.. sourcecode:: bash
+
+   $ hg pull -u
+
+
+Setup
+-----
+
+Add ``'sphinxdoc'`` to your ``INSTALLED_APPS`` within your 
+``settings.py`` and add the following line to your project’s ``urls.py``:
+   
+.. sourcecode:: python
+
+    (r'^docs/', include('sphinxdoc.urls')),
+    
+Install the required database table with:
+
+.. sourcecode:: bash
+
+    python manage.py syncdb
+    
+    
+Add an application
+------------------
+
+If you visit your project’s admin panel, you’ll find the new application
+*Sphinxdoc* with the *App* model. If you add a new app, you’ll need to fill
+three form fields:
+
+Name:
+    The name of the documented application
+    
+Slug:
+    A sluggified version of the application name; will be generated
+    automatically
+
+Path:
+    A file system path to the JSON files generated by Sphinx including
+    ``_build/json/``, e.g.: ``/path/to/app/doc/_build/json/``
+
+
+That’s it!
+----------
+
+You can now find the application’s documentation under */docs/<slug>/*.
+
+You may want to read:
+
+* :ref:`autobuild`
+* :ref:`change_appearance`

docs/ref/index.txt

+.. _ref-index:
+
+API-Reference
+=============
+
+.. toctree::
+    :maxdepth: 1
+    
+    templatetags
+    views

docs/ref/templatetags.txt

+.. ref-templatetags:
+
+Template Tags
+=============

docs/ref/views.txt

+.. _ref-views:
+
+Views
+=====
 #! /usr/bin/env python
 # encoding: utf-8
 
-from setuptools import setup, find_packages
+from distutils.core import setup
 
 
-import sphinxdoc
-
-
-setup(name='django-sphinxdoc',
-    version=sphinxdoc.__version__,
+setup(
+    name='django-sphinxdoc',
+    version='0.3.1',
+    author='Stefan Scherfke',
+    author_email='stefan at sofa-rockers.org',
     description='Easily integrate Sphinx documentation into your website.',
-    author='Stefan Scherfke',
-    author_email='',
-    license='BSD',
+    long_description=open('README.txt').read(),
     url='http://stefan.sofa-rockers.org/django-sphinxdoc/',
     download_url='http://bitbucket.org/scherfke/django-sphinxdoc/downloads/',
-    packages=find_packages(),
-    include_package_data=True,
-    zip_safe=False,
+    license='BSD',
+    packages=[
+        'sphinxdoc', 
+        'sphinxdoc.templatetags',
+    ],
+    package_data={
+        'sphinxdoc': ['templates/sphinxdoc/*'],
+    },
     classifiers=[
         'Development Status :: 4 - Beta',
         'Environment :: Web Environment',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
         'Topic :: Software Development :: Libraries :: Python Modules',
-        'Topic :: Utilities'],
+        'Topic :: Utilities',
+    ],
 )

sphinxdoc/__init__.py

-# encoding: utf-8
-
-__version__ = '0.2'