Skip to content
Snippets Groups Projects
Commit 8f649f5d authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

Merge branch 'p1' into 'master'

[Automatic] update links and the ci mostly



See merge request !6
parents 5941e337 2a7a1c28
Branches
Tags
1 merge request!6[Automatic] update links and the ci mostly
Pipeline #
...@@ -18,8 +18,8 @@ verbose = true ...@@ -18,8 +18,8 @@ verbose = true
newest = false newest = false
[sources] [sources]
bob.extension = git git@gitlab.idiap.ch:bob/bob.extension bob.extension = git https://gitlab.idiap.ch/bob/bob.extension
bob.blitz = git git@gitlab.idiap.ch:bob/bob.blitz bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz
[scripts] [scripts]
recipe = bob.buildout:scripts recipe = bob.buildout:scripts
...@@ -30,9 +30,29 @@ extensions = [ ...@@ -30,9 +30,29 @@ extensions = [
import sphinx import sphinx
if sphinx.__version__ >= "1.4.1": if sphinx.__version__ >= "1.4.1":
extensions.append('sphinx.ext.imgmath') extensions.append('sphinx.ext.imgmath')
imgmath_image_format = 'svg'
else: else:
extensions.append('sphinx.ext.pngmath') 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 # Always includes todos
todo_include_todos = True todo_include_todos = True
...@@ -195,6 +215,7 @@ html_favicon = 'img/favicon.ico' ...@@ -195,6 +215,7 @@ html_favicon = 'img/favicon.ico'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = project_variable + u'_doc' htmlhelp_basename = project_variable + u'_doc'
# -- Post configuration -------------------------------------------------------- # -- Post configuration --------------------------------------------------------
# Included after all input documents # Included after all input documents
...@@ -215,8 +236,13 @@ autodoc_default_flags = [ ...@@ -215,8 +236,13 @@ autodoc_default_flags = [
] ]
# For inter-documentation mapping: # For inter-documentation mapping:
from bob.extension.utils import link_documentation from bob.extension.utils import link_documentation, load_requirements
intersphinx_mapping = link_documentation() 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 # We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions # that are not in the list of accepted functions
......
# no sphinx correlation for these
c:type boost
c:type shared_ptr
c:type mt19937
# this is actually a c type
cpp:type PyObject
cpp:type Py_ssize_t
# exceptions are not found in python 2.7
py:exc ValueError
py:meth __call__
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment