Commit 88d792e2 by Tiago de Freitas Pereira

Merge branch 'update_sphinx' into 'master'

[sphinx] Update conf.py See merge request !2
parents 41152467 11fca520
Pipeline #5535 passed with stages
in 7 minutes 29 seconds
......@@ -25,6 +25,7 @@ extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
#'matplotlib.sphinxext.plot_directive'
]
import sphinx
......@@ -131,7 +132,7 @@ pygments_style = 'sphinx'
# Some variables which are useful for generated material
project_variable = project.replace('.', '_')
short_description = u'BANCA Database Access API for Bob'
short_description = u'Banca Database'
owner = [u'Idiap Research Institute']
......@@ -239,9 +240,12 @@ autodoc_default_flags = [
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=load_requirements(sphinx_requirements))
intersphinx_mapping = link_documentation(
additional_packages=['python','numpy'] + \
load_requirements(sphinx_requirements)
)
else:
intersphinx_mapping = link_documentation()
intersphinx_mapping = link_documentation()
# We want to remove all private (i.e. _. or __.__) members
......@@ -263,3 +267,4 @@ def member_function_test(app, what, name, obj, skip, options):
def setup(app):
app.connect('autodoc-skip-member', member_function_test)
py:class bob.db.base.file.File
py:class bob.db.base.database.SQLiteDatabase
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