conf.py 7.58 KB
Newer Older
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.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
13
needs_sphinx = '1.3'
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 = [
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
18
19
20
21
22
23
24
25
26
27
28
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.ifconfig',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx.ext.doctest',
    'sphinx.ext.graphviz',
    'sphinx.ext.intersphinx',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
    ]
29
30

import sphinx
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
31
32
33
34
if sphinx.__version__ >= "1.4.1":
    extensions.append('sphinx.ext.imgmath')
else:
    extensions.append('sphinx.ext.pngmath')
35
36
37
38

# Always includes todos
todo_include_todos = True

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
39
40
41
42
43
44
# Generates auto-summary automatically
autosummary_generate = True

# Create numbers on figures with captions
numfig = True

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# 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.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
62
project = u'bob.bio.gmm'
63
64
65
66
import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')

# Grab the setup entry
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
67
distribution = pkg_resources.require(project)[0]
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# 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.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
90
exclude_patterns = ['links.rst']
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# 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 = []

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
112
113
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
114
short_description = u'Tools for running biometric recognition experiments'
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
115
116
owner = [u'Idiap Research Institute']

117
118
119
120
121

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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
122
123
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
124
125
126
127
128
129
130

# 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.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
131
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
132
133
134
135
136
137

# 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.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
138
#html_short_title = project_variable
139
140
141

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

# 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.
147
html_favicon = 'img/favicon.ico'
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
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

# 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".
#html_static_path = ['_static']

# 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.
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
196
htmlhelp_basename = project_variable + u'_doc'
197
198


Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
199
# -- Post configuration --------------------------------------------------------
200
201

# Included after all input documents
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
202
203
204
205
206
rst_epilog = """
.. |project| replace:: Bob
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)
207
208

# Default processing flags for sphinx
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
209
autoclass_content = 'class'
210
autodoc_member_order = 'bysource'
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
211
212
213
214
215
216
autodoc_default_flags = [
  'members',
  'undoc-members',
  'inherited-members',
  'show-inheritance',
  ]
217
218

# For inter-documentation mapping:
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
219
220
221
222
223
224
225
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()

Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

# 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
243

244
def setup(app):
Tiago de Freitas Pereira's avatar
Tiago de Freitas Pereira committed
245
  app.connect('autodoc-skip-member', member_function_test)