docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Philo documentation build configuration file, created by
   4 # sphinx-quickstart on Fri Jan 28 14:04:16 2011.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   8 # Note that not all possible configuration values are present in this
   9 # autogenerated file.
  10 #
  11 # All configuration values have a default; values that are commented out
  12 # serve to show the default.
  13
  14 import sys, os
  15
  16 # If extensions (or modules to document with autodoc) are in another directory,
  17 # add these directories to sys.path here. If the directory is relative to the
  18 # documentation root, use os.path.abspath to make it absolute, like shown here.
  19 sys.path.append(os.path.abspath(os.path.dirname(__file__)))
  20 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
  21 sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
  22
  23 os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy-settings'
  24
  25 # Import loader so that loader_tags will be correctly added to builtins. Weird import situations... this is necessary for doc build to work.
  26 from django.template import loader
  27
  28 # HACK to override descriptors that would cause AttributeErrors to be raised otherwise (which would keep them from being documented.)
  29 from philo.contrib.sobol.models import SearchView
  30 SearchView.searches = 5
  31 from philo.models.nodes import TargetURLModel, File
  32 TargetURLModel.reversing_parameters = 5
  33 File.file = 5
  34
  35 # -- General configuration -----------------------------------------------------
  36
  37 # If your documentation needs a minimal Sphinx version, state it here.
  38 needs_sphinx = '1.0'
  39
  40 # Add any Sphinx extension module names here, as strings. They can be extensions
  41 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  42 extensions = ['djangodocs', 'sphinx.ext.autodoc', 'philodocs']
  43
  44 # Add any paths that contain templates here, relative to this directory.
  45 templates_path = ['_templates']
  46
  47 # The suffix of source filenames.
  48 source_suffix = '.rst'
  49
  50 # The encoding of source files.
  51 #source_encoding = 'utf-8-sig'
  52
  53 # The master toctree document.
  54 master_doc = 'index'
  55
  56 # General information about the project.
  57 project = u'Philo'
  58 copyright = u'2009-2012, iThink Software'
  59
  60 # The version info for the project you're documenting, acts as replacement for
  61 # |version| and |release|, also used in various other places throughout the
  62 # built documents.
  63 #
  64 # The short X.Y version.
  65 from philo import VERSION
  66 version = '.'.join([str(v) for v in VERSION])
  67 # The full version, including alpha/beta/rc tags.
  68 release = version
  69
  70 # The language for content autogenerated by Sphinx. Refer to documentation
  71 # for a list of supported languages.
  72 #language = None
  73
  74 # There are two options for replacing |today|: either, you set today to some
  75 # non-false value, then it is used:
  76 #today = ''
  77 # Else, today_fmt is used as the format for a strftime call.
  78 #today_fmt = '%B %d, %Y'
  79
  80 # List of patterns, relative to source directory, that match files and
  81 # directories to ignore when looking for source files.
  82 exclude_patterns = ['_build']
  83
  84 # The reST default role (used for this markup: `text`) to use for all documents.
  85 #default_role = None
  86
  87 # If true, '()' will be appended to :func: etc. cross-reference text.
  88 #add_function_parentheses = True
  89
  90 # If true, the current module name will be prepended to all description
  91 # unit titles (such as .. function::).
  92 #add_module_names = True
  93
  94 # If true, sectionauthor and moduleauthor directives will be shown in the
  95 # output. They are ignored by default.
  96 #show_authors = False
  97
  98 # The name of the Pygments (syntax highlighting) style to use.
  99 pygments_style = 'sphinx'
 100
 101 # A list of ignored prefixes for module index sorting.
 102 #modindex_common_prefix = []
 103
 104
 105 # Autodoc config
 106 autodoc_member_order = "bysource"
 107
 108
 109 # -- Options for HTML output ---------------------------------------------------
 110
 111 # The theme to use for HTML and HTML Help pages.  See the documentation for
 112 # a list of builtin themes.
 113 html_theme = 'default'
 114
 115 # Theme options are theme-specific and customize the look and feel of a theme
 116 # further.  For a list of options available for each theme, see the
 117 # documentation.
 118 #html_theme_options = {}
 119
 120 # Add any paths that contain custom themes here, relative to this directory.
 121 #html_theme_path = []
 122
 123 # The name for this set of Sphinx documents.  If None, it defaults to
 124 # "<project> v<release> documentation".
 125 #html_title = None
 126
 127 # A shorter title for the navigation bar.  Default is the same as html_title.
 128 #html_short_title = None
 129
 130 # The name of an image file (relative to this directory) to place at the top
 131 # of the sidebar.
 132 #html_logo = None
 133
 134 # The name of an image file (within the static path) to use as favicon of the
 135 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 136 # pixels large.
 137 #html_favicon = None
 138
 139 # Add any paths that contain custom static files (such as style sheets) here,
 140 # relative to this directory. They are copied after the builtin static files,
 141 # so a file named "default.css" will overwrite the builtin "default.css".
 142 html_static_path = ['_static']
 143
 144 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 145 # using the given strftime format.
 146 #html_last_updated_fmt = '%b %d, %Y'
 147
 148 # If true, SmartyPants will be used to convert quotes and dashes to
 149 # typographically correct entities.
 150 #html_use_smartypants = True
 151
 152 # Custom sidebar templates, maps document names to template names.
 153 #html_sidebars = {}
 154
 155 # Additional templates that should be rendered to pages, maps page names to
 156 # template names.
 157 #html_additional_pages = {}
 158
 159 # If false, no module index is generated.
 160 #html_domain_indices = True
 161
 162 # If false, no index is generated.
 163 #html_use_index = True
 164
 165 # If true, the index is split into individual pages for each letter.
 166 #html_split_index = False
 167
 168 # If true, links to the reST sources are added to the pages.
 169 #html_show_sourcelink = True
 170
 171 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 172 #html_show_sphinx = True
 173
 174 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 175 #html_show_copyright = True
 176
 177 # If true, an OpenSearch description file will be output, and all pages will
 178 # contain a <link> tag referring to it.  The value of this option must be the
 179 # base URL from which the finished HTML is served.
 180 #html_use_opensearch = ''
 181
 182 # This is the file name suffix for HTML files (e.g. ".xhtml").
 183 #html_file_suffix = None
 184
 185 # Output file base name for HTML help builder.
 186 htmlhelp_basename = 'Philodoc'
 187
 188
 189 # -- Options for LaTeX output --------------------------------------------------
 190
 191 # The paper size ('letter' or 'a4').
 192 #latex_paper_size = 'letter'
 193
 194 # The font size ('10pt', '11pt' or '12pt').
 195 #latex_font_size = '10pt'
 196
 197 # Grouping the document tree into LaTeX files. List of tuples
 198 # (source start file, target name, title, author, documentclass [howto/manual]).
 199 latex_documents = [
 200   ('index', 'Philo.tex', u'Philo Documentation',
 201    u'iThink Software', 'manual'),
 202 ]
 203
 204 # The name of an image file (relative to this directory) to place at the top of
 205 # the title page.
 206 #latex_logo = None
 207
 208 # For "manual" documents, if this is true, then toplevel headings are parts,
 209 # not chapters.
 210 #latex_use_parts = False
 211
 212 # If true, show page references after internal links.
 213 #latex_show_pagerefs = False
 214
 215 # If true, show URL addresses after external links.
 216 #latex_show_urls = False
 217
 218 # Additional stuff for the LaTeX preamble.
 219 #latex_preamble = ''
 220
 221 # Documents to append as an appendix to all manuals.
 222 #latex_appendices = []
 223
 224 # If false, no module index is generated.
 225 #latex_domain_indices = True
 226
 227
 228 # -- Options for manual page output --------------------------------------------
 229
 230 # One entry per manual page. List of tuples
 231 # (source start file, name, description, authors, manual section).
 232 man_pages = [
 233     ('index', 'philo', u'Philo Documentation',
 234      [u'iThink Software'], 1)
 235 ]
 236
 237 def skip_attribute_attrs(app, what, name, obj, skip, options):
 238         if name in ("attribute_set", "get_attribute_mapper", "nodes"):
 239                 return True
 240         return skip
 241
 242 def setup(app):
 243         app.connect('autodoc-skip-member', skip_attribute_attrs)
 244         #app.connect('autodoc-process-signature', )