Permalink
Browse files

Version bump and doc updates

  • Loading branch information...
1 parent b5cb43f commit c0a9e831b8497c00cac626816d89cf1f6836b60c @flashingpumpkin committed Feb 22, 2012
View
@@ -11,8 +11,10 @@ BUILDDIR = _build
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
+.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"
@@ -29,6 +31,9 @@ help:
@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)"
@@ -113,6 +118,24 @@ 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
View
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
# django-socialregistration documentation build configuration file, created by
-# sphinx-quickstart on Tue Oct 4 12:05:14 2011.
+# sphinx-quickstart on Wed Feb 22 17:25:59 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
#
@@ -11,7 +11,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os
+import sys, os, socialregistration
os.environ['DJANGO_SETTINGS_MODULE'] = 'example.settings'
@@ -27,7 +27,7 @@
# 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']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -43,16 +43,16 @@
# General information about the project.
project = u'django-socialregistration'
-copyright = u'2011, Alen Mujezinovic'
+copyright = u'2012, Alen Mujezinovic'
# 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.5'
+version = '0.5.1'
# The full version, including alpha/beta/rc tags.
-release = '0.5'
+release = '0.5.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -171,16 +171,21 @@
# -- Options for LaTeX output --------------------------------------------------
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'django-socialregistration.tex', u'django-socialregistration Documentation',
+ ('fooasdf', 'django-socialregistration.tex', u'django-socialregistration Documentation',
u'Alen Mujezinovic', 'manual'),
]
@@ -198,9 +203,6 @@
# If true, show URL addresses after external links.
#latex_show_urls = False
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
# Documents to append as an appendix to all manuals.
#latex_appendices = []
@@ -213,6 +215,30 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'django-socialregistration', u'django-socialregistration Documentation',
+ ('fooasdf', 'django-socialregistration', u'django-socialregistration Documentation',
[u'Alen Mujezinovic'], 1)
]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('fooasdf', 'django-socialregistration', u'django-socialregistration Documentation',
+ u'Alen Mujezinovic', 'django-socialregistration', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
View
@@ -9,4 +9,14 @@
api.rst
settings.rst
+
+API
+===
+
+.. toctree::
+ :maxdepth: 3
+
+ socialregistration.rst
+
+
Made by `Caffeinehit Ltd <http://www.caffeinehit.com/>`_.
@@ -0,0 +1,19 @@
+clients Package
+===============
+
+:mod:`clients` Package
+----------------------
+
+.. automodule:: socialregistration.clients
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`oauth` Module
+-------------------
+
+.. automodule:: socialregistration.clients.oauth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
@@ -0,0 +1,42 @@
+facebook Package
+================
+
+:mod:`auth` Module
+------------------
+
+.. automodule:: socialregistration.contrib.facebook.auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.facebook.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`middleware` Module
+------------------------
+
+.. automodule:: socialregistration.contrib.facebook.middleware
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`models` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.facebook.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`views` Module
+-------------------
+
+.. automodule:: socialregistration.contrib.facebook.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
@@ -0,0 +1,35 @@
+foursquare Package
+==================
+
+:mod:`auth` Module
+------------------
+
+.. automodule:: socialregistration.contrib.foursquare.auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.foursquare.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`models` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.foursquare.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`views` Module
+-------------------
+
+.. automodule:: socialregistration.contrib.foursquare.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
@@ -0,0 +1,35 @@
+github Package
+==============
+
+:mod:`auth` Module
+------------------
+
+.. automodule:: socialregistration.contrib.github.auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.github.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`models` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.github.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`views` Module
+-------------------
+
+.. automodule:: socialregistration.contrib.github.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
@@ -0,0 +1,35 @@
+linkedin Package
+================
+
+:mod:`auth` Module
+------------------
+
+.. automodule:: socialregistration.contrib.linkedin.auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.linkedin.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`models` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.linkedin.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`views` Module
+-------------------
+
+.. automodule:: socialregistration.contrib.linkedin.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
@@ -0,0 +1,44 @@
+openid Package
+==============
+
+
+:mod:`auth` Module
+------------------
+
+.. automodule:: socialregistration.contrib.openid.auth
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`client` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.openid.client
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`models` Module
+--------------------
+
+.. automodule:: socialregistration.contrib.openid.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`storage` Module
+---------------------
+
+.. automodule:: socialregistration.contrib.openid.storage
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+:mod:`views` Module
+-------------------
+
+.. automodule:: socialregistration.contrib.openid.views
+ :members:
+ :undoc-members:
+ :show-inheritance:
Oops, something went wrong.

0 comments on commit c0a9e83

Please sign in to comment.