Add Sphinx support. Draft of documentation from google code translated to restructured text.

Author: Daniel Mizyrycki

docs/Makefile

@@ -0,0 +1,75 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview over all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+
+clean:
+	-rm -rf _build/*
+
+html:
+	mkdir -p _build/html _build/doctrees _static
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+	@echo
+	@echo "Build finished. The HTML pages are in _build/html."
+
+pickle:
+	mkdir -p _build/pickle _build/doctrees
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+web: pickle
+
+json:
+	mkdir -p _build/json _build/doctrees
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	mkdir -p _build/htmlhelp _build/doctrees
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in _build/htmlhelp."
+
+latex:
+	mkdir -p _build/latex _build/doctrees
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in _build/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	mkdir -p _build/changes _build/doctrees
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
+	@echo
+	@echo "The overview file is in _build/changes."
+
+linkcheck:
+	mkdir -p _build/linkcheck _build/doctrees
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in _build/linkcheck/output.txt."

docs/admin_extensions.rst

@@ -0,0 +1,15 @@
+Current Admin Extensions
+========================
+
+:synopsis: Current Field Extensions
+
+
+* *ForeignKeyAutocompleteAdmin* - ForeignKeyAutocompleteAdmin will enable the
+  admin app to show ForeignKey fields with an search input field. The search
+  field is rendered by the ForeignKeySearchInput form widget and uses jQuery
+  to do configureable autocompletion.
+
+You can watch a small demo at Flickr_.
+
+
+.. _Flickr: http://www.flickr.com/photos/jannis/3246408003/

docs/command_extension_ideas.rst

@@ -0,0 +1,7 @@
+Ideas for New Command Extensions
+================================
+
+:synopsis: Here are some ideas for some future command extensions.
+
+* create form/manager for App
+* CSS and JS concatenation and minification scripts

docs/command_extensions.rst

@@ -0,0 +1,89 @@
+Current Command Extensions
+==========================
+
+:synopsis: Current Command Extensions
+
+
+* *create_app* - Creates an application directory structure for the specified
+  app name.  This command allows you to specify the --template option where you
+  can indicate a template directory structure to use as your default.
+
+* *create_command* - Creates a command extension directory structure within the
+  specified application.  This makes it easy to get started with adding a
+  command extension to your application.
+
+* *create_jobs* - Creates a Django jobs command directory structure for the
+  given app name in the current directory.  This is part of the impressive jobs
+  system.
+
+* *create_superuser* - Makes it easy to create a superuser for the
+  django.contrib.auth.
+
+* *describe_form* - Used to display a form definition for a model.  Copy and
+  paste the contents into your forms.py and you're ready to go.
+
+* :doc:`dumpscript <dumpscript>` - Generates a Python script that will
+  repopulate the database using objects. The advantage of this approach is that
+  it is easy to understand, and more flexible than directly populating the
+  database, or using XML.
+
+* `export_emails`_ - export the email addresses for your
+  users in one of many formats.  Currently supports Address, Google, Outlook,
+  LinkedIn, and VCard formats.
+
+* *generate_secret_key* - Creates a new secret key that you can put in your
+  settings.py module.
+
+* `graph_models`_ - Creates a GraphViz_ dot file.  You need
+  to send this output to a file yourself.  Great for graphing your models. Pass
+  multiple application names to combine all the models into a single dot file.
+
+* *mail_debug* - Starts a mail server which echos out the contents of the email
+  instead of sending it.
+
+* *passwd* - Makes it easy to reset a user's password.
+
+* *print_user_for_session* - Print the user information for the provided
+  session key. this is very helpful when trying to track down the person who
+  experienced a site crash.
+
+* *reset_db* - Resets a database (currently sqlite3, mysql, postgres).
+
+* *runjob* - Run a single maintenance job.  Part of the jobs system.
+
+* *runjobs* - Runs scheduled maintenance jobs. Specify hourly, daily, weekly,
+  monthly.  Part of the jobs system.
+
+* :doc:`runprofileserver <runprofileserver>` - Starts *runserver* with hotshot/profiling tools enabled.
+  I haven't had a chance to check this one out, but it looks really cool.
+
+* *runscript* - Runs a script in django context.
+
+* `runserver_plus`_ - The standard runserver stuff but with
+  the Werkzeug debugger baked in. Requires Werkzeug_. This one kicks ass.
+
+* *set_fake_passwords* -  Sets all user passwords to a common value (*password* by default). *DEBUG only*.
+
+* *shell_plus* - An enhanced version of the Django shell.  It will autoload
+  all your models making it easy to work with the ORM right away.
+
+* *show_urls* - Displays the url routes that are defined in your project. Very
+  crude at this point.
+
+* *sqldiff* - Prints the (approximated) difference between an apps models and
+  what is in the database.  This is very nice, but also very experimental at
+  the moment.  It can not catch everything but it's a great sanity check.
+
+* `sync_media_s3`_ - Copies files found in settings.MEDIA_ROOT to S3.
+  Optionally can also gzip CSS and Javascript files and set the
+  Content-Encoding header, and also set a far future expires header for browser
+  caching.
+
+
+.. _`create_app`: create_app.html
+.. _`export_emails`: export_emails.html
+.. _`graph_models`: graph_models.html
+.. _`runserver_plus`: runserver_plus.html
+.. _`sync_media_s3`: sync_media_s3.html
+.. _GraphViz: http://www.graphviz.org/
+.. _Werkzeug: http://werkzeug.pocoo.org/

docs/conf.py

@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# django-extensions documentation build configuration file, created by
+# sphinx-quickstart on Wed Apr  1 20:39:40 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
+
+# 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('.'))
+
+# -- 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-extensions'
+copyright = u'Copyright (C) 2008, 2009 Michael Trier and contributors'
+
+# 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.4'
+# The full version, including alpha/beta/rc tags.
+release = '0.4'
+
+# 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-extensionsdoc'
+
+
+# -- 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-extensions.tex', u'django-extensions Documentation',
+   u'Michael Trier', '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