Moving the LICENSE file to the root.

[philo.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index a879f03..c888d0e 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,15 +17,28 @@ import sys, os
 # 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.join(os.path.dirname(__file__), "_ext")))
 # 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.join(os.path.dirname(__file__), "_ext")))

+sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
+
+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.
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.

-#needs_sphinx = '1.0'
+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.
 
 # 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']
+extensions = ['djangodocs', 'sphinx.ext.autodoc', 'philodocs']

 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']


@@ -48,9 +61,10 @@ copyright = u'2011, Joseph Spiros'
 # built documents.
 #
 # The short X.Y version.
 # built documents.
 #
 # The short X.Y version.

-version = '1.0'
+from philo import VERSION
+version = '%s.%s' % (VERSION[0], VERSION[1])

 # The full version, including alpha/beta/rc tags.
 # The full version, including alpha/beta/rc tags.

-release = '1.0a1'
+release = version

 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.


@@ -87,6 +101,10 @@ pygments_style = 'sphinx'
 #modindex_common_prefix = []
 
 
 #modindex_common_prefix = []
 
 

+# Autodoc config
+autodoc_member_order = "bysource"
+
+

 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for


@@ -214,3 +232,12 @@ man_pages = [
     ('index', 'philo', u'Philo Documentation',
      [u'Stephen Burrows'], 1)
 ]
     ('index', 'philo', u'Philo Documentation',
      [u'Stephen Burrows'], 1)
 ]

+
+def skip_attribute_attrs(app, what, name, obj, skip, options):
+       if name in ("attribute_set", "get_attribute_mapper", "nodes"):
+               return True
+       return skip
+
+def setup(app):
+       app.connect('autodoc-skip-member', skip_attribute_attrs)
+       #app.connect('autodoc-process-signature', )