conf.py 8.44 KB
Newer Older
Pedro TOME's avatar
Pedro TOME committed
1 2 3 4 5 6 7 8 9 10 11 12
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :

import os
import sys
import glob
import pkg_resources


# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
André Anjos's avatar
André Anjos committed
13
needs_sphinx = '1.3'
Pedro TOME's avatar
Pedro TOME committed
14 15 16 17

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
André Anjos's avatar
André Anjos committed
18 19 20 21 22 23 24
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.ifconfig',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.doctest',
    'sphinx.ext.graphviz',
André Anjos's avatar
André Anjos committed
25
    'sphinx.ext.intersphinx',
André Anjos's avatar
André Anjos committed
26 27
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
28
    'sphinx.ext.mathjax',
André Anjos's avatar
André Anjos committed
29
    ]
Pedro TOME's avatar
Pedro TOME committed
30

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
# Be picky about warnings
nitpicky = True

# Ignores stuff we can't easily resolve on other project's sphinx manuals
nitpick_ignore = []

# Allows the user to override warnings from a separate file
if os.path.exists('nitpick-exceptions.txt'):
    for line in open('nitpick-exceptions.txt'):
        if line.strip() == "" or line.startswith("#"):
            continue
        dtype, target = line.split(None, 1)
        target = target.strip()
        try: # python 2.x
            target = unicode(target)
        except NameError:
            pass
        nitpick_ignore.append((dtype, target))

Pedro TOME's avatar
Pedro TOME committed
50 51 52
# Always includes todos
todo_include_todos = True

André Anjos's avatar
André Anjos committed
53 54 55
# Generates auto-summary automatically
autosummary_generate = True

André Anjos's avatar
André Anjos committed
56 57 58
# Create numbers on figures with captions
numfig = True

Pedro TOME's avatar
Pedro TOME committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
# If we are on OSX, the 'dvipng' path maybe different
dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng'
if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx

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

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
André Anjos's avatar
André Anjos committed
76
project = u'bob.bio.vein'
Pedro TOME's avatar
Pedro TOME committed
77 78 79 80
import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')

# Grab the setup entry
André Anjos's avatar
André Anjos committed
81
distribution = pkg_resources.require(project)[0]
Pedro TOME's avatar
Pedro TOME committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125

# 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 = distribution.version
# The full version, including alpha/beta/rc tags.
release = distribution.version

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

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['links.rst']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

André Anjos's avatar
André Anjos committed
126 127
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
André Anjos's avatar
André Anjos committed
128
short_description = u'Vein Recognition Library'
André Anjos's avatar
André Anjos committed
129
owner = [u'Idiap Research Institute']
Pedro TOME's avatar
Pedro TOME committed
130 131 132 133 134 135


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
André Anjos's avatar
André Anjos committed
136 137
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
Pedro TOME's avatar
Pedro TOME committed
138 139 140 141 142 143 144

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
André Anjos's avatar
André Anjos committed
145
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
Pedro TOME's avatar
Pedro TOME committed
146 147 148 149 150 151

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
André Anjos's avatar
André Anjos committed
152
#html_short_title = project_variable
Pedro TOME's avatar
Pedro TOME committed
153 154 155 156 157 158 159 160 161 162 163 164 165

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'img/logo.png'

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = 'img/favicon.ico'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
André Anjos's avatar
André Anjos committed
166
#html_static_path = ['_static']
Pedro TOME's avatar
Pedro TOME committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
André Anjos's avatar
André Anjos committed
210
htmlhelp_basename = project_variable + u'_doc'
Pedro TOME's avatar
Pedro TOME committed
211 212


André Anjos's avatar
André Anjos committed
213
# -- Post configuration --------------------------------------------------------
Pedro TOME's avatar
Pedro TOME committed
214

André Anjos's avatar
André Anjos committed
215 216 217 218 219 220
# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)
Pedro TOME's avatar
Pedro TOME committed
221 222

# Default processing flags for sphinx
André Anjos's avatar
André Anjos committed
223
autoclass_content = 'class'
Pedro TOME's avatar
Pedro TOME committed
224
autodoc_member_order = 'bysource'
André Anjos's avatar
André Anjos committed
225 226 227 228 229
autodoc_default_flags = [
  'members',
  'undoc-members',
  'show-inheritance',
  ]
Pedro TOME's avatar
Pedro TOME committed
230 231

# For inter-documentation mapping:
232 233 234 235 236 237 238
from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements):
    intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements))
else:
    intersphinx_mapping = link_documentation()

239 240 241 242 243
# Add scikit-image link
skimage_version = pkg_resources.require('scikit-image')[0].version
skimage_version = '.'.join(skimage_version.split('.')[:2])
intersphinx_mapping['http://scikit-image.org/docs/%s.x' % skimage_version] = \
    None
André Anjos's avatar
André Anjos committed
244

André Anjos's avatar
André Anjos committed
245 246 247 248 249 250
# Add PIL link
pil_version = pkg_resources.require('pillow')[0].version
pil_version = '.'.join(pil_version.split('.')[:2])
intersphinx_mapping['http://pillow.readthedocs.io/en/%s.x' % pil_version] = \
    None

André Anjos's avatar
André Anjos committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions = ['__array__']

def member_function_test(app, what, name, obj, skip, options):
  # test if we have a private function
  if len(name) > 1 and name[0] == '_':
    # test if this private function should be allowed
    if name not in accepted_private_functions:
      # omit privat functions that are not in the list of accepted private functions
      return skip
    else:
      # test if the method is documented
      if not hasattr(obj, '__doc__') or not obj.__doc__:
        return skip
  return False
Pedro TOME's avatar
Pedro TOME committed
267 268

def setup(app):
André Anjos's avatar
André Anjos committed
269
  app.connect('autodoc-skip-member', member_function_test)