X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/30c59c96869c9996540f1cf844dadd38d00ab8f3..5c919ea0dec366d8d78fee8944577c454f335b2a:/docs/conf.py?ds=sidebyside diff --git a/docs/conf.py b/docs/conf.py index cad16d6..b1329ba 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,7 @@ 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(os.path.dirname(__file__))) sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))) sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__)))) @@ -24,6 +25,13 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy-settings' # Import loader so that loader_tags will be correctly added to builtins. Weird import situations... this is necessary for doc build to work. from django.template import loader +# HACK to override descriptors that would cause AttributeErrors to be raised otherwise (which would keep them from being documented.) +from philo.contrib.sobol.models import SearchView +SearchView.searches = 5 +from philo.models.nodes import TargetURLModel, File +TargetURLModel.reversing_parameters = 5 +File.file = 5 + # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -31,7 +39,7 @@ needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['djangodocs', 'sphinx.ext.autodoc'] +extensions = ['djangodocs', 'sphinx.ext.autodoc', 'philodocs'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -47,7 +55,7 @@ master_doc = 'index' # General information about the project. project = u'Philo' -copyright = u'2011, Joseph Spiros' +copyright = u'2009-2012, iThink Software' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -55,7 +63,7 @@ copyright = u'2011, Joseph Spiros' # # The short X.Y version. from philo import VERSION -version = '%s.%s' % (VERSION[0], VERSION[1]) +version = '.'.join([str(v) for v in VERSION]) # The full version, including alpha/beta/rc tags. release = version @@ -190,7 +198,7 @@ htmlhelp_basename = 'Philodoc' # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'Philo.tex', u'Philo Documentation', - u'Stephen Burrows', 'manual'), + u'iThink Software', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -223,7 +231,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'philo', u'Philo Documentation', - [u'Stephen Burrows'], 1) + [u'iThink Software'], 1) ] def skip_attribute_attrs(app, what, name, obj, skip, options): @@ -233,3 +241,4 @@ def skip_attribute_attrs(app, what, name, obj, skip, options): def setup(app): app.connect('autodoc-skip-member', skip_attribute_attrs) + #app.connect('autodoc-process-signature', )