X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/a7c05c72e5a1740f6ad7faac157a326cca4efb2a..c19bf577d44606d2b284e6058d633f4a174b61cc:/docs/conf.py?ds=sidebyside diff --git a/docs/conf.py b/docs/conf.py index ece87fc..c888d0e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,6 +21,16 @@ 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. @@ -28,7 +38,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'] @@ -51,9 +61,10 @@ copyright = u'2011, Joseph Spiros' # 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. -release = '1.0a1' +release = version # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -90,6 +101,10 @@ pygments_style = 'sphinx' #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 @@ -217,3 +232,12 @@ man_pages = [ ('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', )