Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
bob
bob.pad.voice
Commits
ed59cbd8
Commit
ed59cbd8
authored
Oct 12, 2016
by
Pavel KORSHUNOV
Browse files
[sphinx] Fixed Warnings
parent
d7258360
Pipeline
#4753
passed with stages
in 20 minutes and 27 seconds
Changes
4
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
doc/conf.py
View file @
ed59cbd8
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
# Andre Anjos <andre.anjos@idiap.ch>
# Mon 13 Aug 2012 12:38:15 CEST
#
# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland
import
os
import
sys
import
glob
import
pkg_resources
# If extensions (or modules to document with autodoc) are in another directory,
# 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.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
needs_sphinx = '1.
0
'
needs_sphinx
=
'1.
3
'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions
=
[
'sphinx.ext.todo'
,
'sphinx.ext.coverage'
,
'sphinx.ext.pngmath'
,
'sphinx.ext.ifconfig'
,
'sphinx.ext.autodoc'
,
'sphinx.ext.autosummary'
,
'sphinx.ext.doctest'
,
'sphinx.ext.intersphinx'
,
]
'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'
,
]
# The viewcode extension appeared only on Sphinx >= 1.0.0
import
sphinx
if
sphinx
.
__version__
>=
"1.0"
:
extensions
.
append
(
'sphinx.ext.viewcode'
)
if
sphinx
.
__version__
>=
"1.4.1"
:
extensions
.
append
(
'sphinx.ext.imgmath'
)
imgmath_image_format
=
'svg'
else
:
extensions
.
append
(
'sphinx.ext.pngmath'
)
# 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
))
# Always includes todos
todo_include_todos
=
True
# Generates auto-summary automatically
autosummary_generate
=
True
# Create numbers on figures with captions
numfig
=
True
# 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
...
...
@@ -58,18 +79,21 @@ source_suffix = '.rst'
master_doc
=
'index'
# General information about the project.
project
=
u
'
PAD
voice'
project
=
u
'
bob.pad.
voice'
import
time
copyright
=
u
'%s, Idiap Research Institute'
%
time
.
strftime
(
'%Y'
)
# Grab the setup entry
distribution
=
pkg_resources
.
require
(
project
)[
0
]
# 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
=
1.0
version
=
distribution
.
version
# The full version, including alpha/beta/rc tags.
release
=
1.0
release
=
distribution
.
version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
...
...
@@ -83,7 +107,7 @@ release = 1.0
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
#
exclude_patterns = ['
**/
links.rst']
exclude_patterns
=
[
'links.rst'
]
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
...
...
@@ -105,13 +129,18 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# Some variables which are useful for generated material
project_variable
=
project
.
replace
(
'.'
,
'_'
)
short_description
=
u
'Extension of bob.pad.base framework for voice'
owner
=
[
u
'Idiap Research Institute'
]
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
i
f
sphinx
.
__version__
>=
"1.0"
:
html_theme
=
'
natur
e'
i
mport
sphinx
_rtd_theme
html_theme
=
'
sphinx_rtd_them
e'
# 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
...
...
@@ -119,28 +148,28 @@ if sphinx.__version__ >= "1.0":
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#
html_theme_path = []
html_theme_path
=
[
sphinx_rtd_theme
.
get_html_theme_path
()
]
# 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.
#html_short_title =
'bob'
#html_short_title =
project_variable
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo
=
''
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
=
''
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".
html_static_path
=
[
'_static'
]
#
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
...
...
@@ -184,67 +213,53 @@ html_static_path = ['_static']
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename
=
'bobpaperdoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
latex_paper_size
=
'a4'
# The font size ('10pt', '11pt' or '12pt').
latex_font_size
=
'10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents
=
[
(
'index'
,
'pad_voice_package.tex'
,
u
'Bob'
,
u
'Biometrics Group, Idiap Research Institute'
,
'manual'
),
]
htmlhelp_basename
=
project_variable
+
u
'_doc'
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo
=
''
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Post configuration --------------------------------------------------------
# Included after all input documents
rst_epilog
=
''
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages
=
[
(
'index'
,
'bob.pad.voice'
,
u
'PAD Voice Package'
,
[
u
'Idiap Research Institute'
],
1
)
]
rst_epilog
=
"""
.. |project| replace:: Bob
.. |version| replace:: %s
.. |current-year| date:: %%Y
"""
%
(
version
,)
# Default processing flags for sphinx
autoclass_content
=
'
both
'
autoclass_content
=
'
class
'
autodoc_member_order
=
'bysource'
autodoc_default_flags
=
[
'members'
,
'undoc-members'
,
'inherited-members'
,
'show-inheritance'
]
autodoc_default_flags
=
[
'members'
,
'undoc-members'
,
'inherited-members'
,
'show-inheritance'
,
]
# For inter-documentation mapping:
#from bob.extension.utils import link_documentation
#intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.db.base', 'bob.pad.base'])
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
()
# 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
def
setup
(
app
):
pass
app
.
connect
(
'autodoc-skip-member'
,
member_function_test
)
\ No newline at end of file
doc/img/favicon.ico
0 → 100644
View file @
ed59cbd8
4.19 KB
doc/img/logo.png
0 → 100644
View file @
ed59cbd8
6.12 KB
doc/index.rst
View file @
ed59cbd8
...
...
@@ -2,6 +2,8 @@
.. Pavel Korshunov <pavel.korshunov@idiap.ch>
.. Thu 23 Jun 13:43:22 2016
.. _bob.pad.voice:
=================================================
Presentation Attack Detection in Voice Biometrics
=================================================
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment