Commit 2ad1706a authored by Tiago de Freitas Pereira's avatar Tiago de Freitas Pereira
Browse files

[sphinx] Update conf.py

parent e194cfb1
Pipeline #5538 passed with stages
in 4 minutes and 15 seconds
...@@ -25,6 +25,7 @@ extensions = [ ...@@ -25,6 +25,7 @@ extensions = [
'sphinx.ext.intersphinx', 'sphinx.ext.intersphinx',
'sphinx.ext.napoleon', 'sphinx.ext.napoleon',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
#'matplotlib.sphinxext.plot_directive'
] ]
import sphinx import sphinx
...@@ -131,7 +132,7 @@ pygments_style = 'sphinx' ...@@ -131,7 +132,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'ATVS-Keystroke Database Access API for Bob' short_description = u'ATVS KeyStroke'
owner = [u'Idiap Research Institute'] owner = [u'Idiap Research Institute']
...@@ -239,9 +240,12 @@ autodoc_default_flags = [ ...@@ -239,9 +240,12 @@ autodoc_default_flags = [
from bob.extension.utils import link_documentation, load_requirements from bob.extension.utils import link_documentation, load_requirements
sphinx_requirements = "extra-intersphinx.txt" sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements): if os.path.exists(sphinx_requirements):
intersphinx_mapping = link_documentation(additional_packages=load_requirements(sphinx_requirements)) intersphinx_mapping = link_documentation(
additional_packages=['python','numpy'] + \
load_requirements(sphinx_requirements)
)
else: else:
intersphinx_mapping = link_documentation() intersphinx_mapping = link_documentation()
# We want to remove all private (i.e. _. or __.__) members # We want to remove all private (i.e. _. or __.__) members
...@@ -263,3 +267,4 @@ def member_function_test(app, what, name, obj, skip, options): ...@@ -263,3 +267,4 @@ def member_function_test(app, what, name, obj, skip, options):
def setup(app): def setup(app):
app.connect('autodoc-skip-member', member_function_test) app.connect('autodoc-skip-member', member_function_test)
py:class bob.db.base.file.File py:class bob.db.base.file.File
py:class bob.db.base.database.SQLiteDatabase py:class bob.db.base.database.SQLiteDatabase
py:class sqlalchemy.ext.declarative.api.Base py:class sqlalchemy.ext.declarative.api.Base
py:exc ValueError
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