Skip to content
Snippets Groups Projects
Commit c3cb20a9 authored by Amir Mohammadi's avatar Amir Mohammadi
Browse files

[Automatic] update links and the ci mostly

parent 08e84be1
No related branches found
No related tags found
1 merge request!13[Automatic] update links and the ci mostly
...@@ -19,9 +19,9 @@ verbose = true ...@@ -19,9 +19,9 @@ 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
bob.core = git git@gitlab.idiap.ch:bob/bob.core bob.core = git https://gitlab.idiap.ch/bob/bob.core
[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
...@@ -59,7 +79,7 @@ source_suffix = '.rst' ...@@ -59,7 +79,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'bob.io.base' project = u'<PROJECT>'
import time import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
...@@ -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'Basic IO for Bob' short_description = u'<SHORT_DESCRIPTION>'
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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment