Skip to content
Snippets Groups Projects

[Automatic] update links and the ci mostly

Merged Amir MOHAMMADI requested to merge p1 into master
1 file
+ 29
4
Compare changes
  • Side-by-side
  • Inline
+ 29
4
@@ -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
@@ -111,7 +131,7 @@ pygments_style = 'sphinx'
@@ -111,7 +131,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
project_variable = project.replace('.', '_')
short_description = u'<SHORT_DESCRIPTION>'
short_description = u'MNIST Database Access API for Bob'
owner = [u'Idiap Research Institute']
owner = [u'Idiap Research Institute']
@@ -216,8 +236,13 @@ autodoc_default_flags = [
@@ -216,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
@@ -237,4 +262,4 @@ def member_function_test(app, what, name, obj, skip, options):
@@ -237,4 +262,4 @@ def member_function_test(app, what, name, obj, skip, options):
return False
return False
def setup(app):
def setup(app):
app.connect('autodoc-skip-member', member_function_test)
app.connect('autodoc-skip-member', member_function_test)
\ No newline at end of file
Loading