Commit a006215c authored by André Anjos's avatar André Anjos

Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !3
parents 4de54d8f 57a3aa6c
Pipeline #4756 passed with stages
in 17 minutes and 40 seconds
......@@ -20,10 +20,10 @@ verbose = true
newest = false
[sources]
bob.extension = git git@gitlab.idiap.ch:bob/bob.extension
bob.blitz = git git@gitlab.idiap.ch:bob/bob.blitz
bob.core = git git@gitlab.idiap.ch:bob/bob.core
bob.sp = git git@gitlab.idiap.ch:bob/bob.sp
bob.extension = git https://gitlab.idiap.ch/bob/bob.extension
bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz
bob.core = git https://gitlab.idiap.ch/bob/bob.core
bob.sp = git https://gitlab.idiap.ch/bob/bob.sp
[scripts]
recipe = bob.buildout:scripts
......@@ -25,14 +25,35 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
#'matplotlib.sphinxext.plot_directive'
]
import sphinx
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
......@@ -111,7 +132,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
short_description = u'Basic audio utilities for Bob'
short_description = u'Bob\'s audio processing utilities'
owner = [u'Idiap Research Institute']
......@@ -216,8 +237,16 @@ autodoc_default_flags = [
]
# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation()
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=['python','numpy'] + \
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
......
......@@ -50,9 +50,10 @@ Other features can be computed in a similar fashion (please check Python API for
Reading audio files
~~~~~~~~~~~~~~~~~~~
The usual native formats can be read with :py:mod:`scipy.io.wavfile` module. Other
wave formats can be found in some other python modules like :py:mod:`pysox`. An
example of wave file can be found here ``bob/ap/test/data/sample.wav``
The usual native formats can be read with :py:mod:`scipy.io.wavfile` module.
These and other wave formats can be read through SoX_ using our native
bindings at :py:mod:`bob.io.audio`. An example of wave file can be found at
``bob/ap/test/data/sample.wav``.
.. doctest:: aptest
:options: +NORMALIZE_WHITESPACE
......@@ -147,3 +148,4 @@ It is also possible to compute first and second derivatives for those features:
>>> print(len(lfcc_e_d_dd[0]))
60
.. include:: links.rst
......@@ -78,3 +78,4 @@
.. _libpng license: http://www.libpng.org/pub/png/src/libpng-LICENSE.txt
.. _mit: http://www.opensource.org/licenses/MIT
.. _python-2.0: http://www.opensource.org/licenses/Python-2.0
.. _sox: http://sox.sourceforge.net/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment