Python link_documentation Examples

Example #1

File: conf.py Project: Verderey/bob.db.voxforge

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bob', u'BANCA (Bob API) Documentation',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation([
    'python', 'bob.db.base', 'bob.db.verification.utils',
    'bob.db.verification.filelist', 'bob.bio.spear'
])


def setup(app):
    pass

Example #2

File: conf.py Project: 183amir/bob.db.casme2

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'CASME2 Database (Bob API) Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'bob.db.base', 'bob.db.verification.utils'])


def setup(app):
  pass

Example #3

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bob.bio.base',
              u'Base tools to run biometric recognition experiments',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation

intersphinx_mapping = link_documentation([
    'python', 'numpy', 'bob.bio.face', 'bob.bio.speaker', 'bob.bio.gmm',
    'bob.bio.video', 'bob.bio.csu', 'bob.bio.spear', 'gridtk', 'bob.db.youtube'
])


def skip(app, what, name, obj, skip, options):
    # Do not skip the __call__ and the __str__ functions as we have special implementations for them.
    if name in ("__str__", "__call__"):
        return False
    return skip


# getting dictionaries printed nicely.
# see: http://stackoverflow.com/questions/7250659/python-code-to-generate-part-of-sphinx-documentation-is-it-possible/18143318#18143318
try:
    from StringIO import StringIO
except ImportError:

Example #4

File: conf.py Project: Verderey/bob.db.voxforge

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'BANCA (Bob API) Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'bob.db.base', 'bob.db.verification.utils', 'bob.db.verification.filelist', 'bob.bio.spear'])


def setup(app):
  pass

Example #5

File: conf.py Project: tiagofrepereira2012/bob.extension

.. |current-year| date:: %%Y
""" % (version, )

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob_extension', u'Bob Extension Building Documentation',
     [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members',
    'undoc-members',
    'inherited-members',
    'show-inheritance',
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(
    additional_packages=['python', 'bob.blitz', 'bob.db.base'])


def setup(app):
    pass

Example #6

File: conf.py Project: 183amir/bob.db.avspoof

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bob', u'AVspoof (Bob API) Documentation',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation([
    'python', 'bob.db.base', 'bob.db.verification.utils', 'antispoofing.utils',
    'bob.spear'
])


def setup(app):
    pass

Example #7

File: conf.py Project: tiagofrepereira2012/bob.learn.mlp

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (
    version,
)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [("index", "bob_learn_mlp", u"Bob Multi-Layer Perceptron Documentation", [u"Idiap Research Institute"], 1)]

# Default processing flags for sphinx
autoclass_content = "both"
autodoc_member_order = "bysource"
autodoc_default_flags = ["members", "undoc-members", "inherited-members", "show-inheritance"]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation

# the documentation also links to bob.learn.linear
intersphinx_mapping = link_documentation(["python", "numpy", "bob.learn.linear"])


def setup(app):
    pass

Example #8

File: conf.py Project: bioidiap/bob.kaldi

.. |current-year| date:: %%Y
""" % (version, )

# Default processing flags for sphinx
autoclass_content = "class"
autodoc_member_order = "bysource"
autodoc_default_flags = [
    "members",
    "undoc-members",
    "show-inheritance",
]

sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements):
    intersphinx_mapping = link_documentation(
        additional_packages=["python", "numpy"] +
        load_requirements(sphinx_requirements))
else:
    intersphinx_mapping = link_documentation()

# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions = ["__array__"]


def member_function_test(app, what, name, obj, skip, options):
    # test if we have a private function
    if len(name) > 1 and name[0] == "_":
        # test if this private function should be allowed
        if name not in accepted_private_functions:
            # omit privat functions that are not in the list of accepted private functions

Example #9

File: conf.py Project: sun8608/bob.bio.base

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.bio.base', u'Base tools to run biometric recognition experiments', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.bio.face', 'bob.bio.speaker', 'bob.bio.gmm', 'bob.bio.video', 'bob.bio.csu', 'bob.bio.spear', 'gridtk', 'bob.db.youtube'])


def skip(app, what, name, obj, skip, options):
  # Do not skip the __call__ and the __str__ functions as we have special implementations for them.
  if name in ("__str__", "__call__"):
    return False
  return skip

# getting dictionaries printed nicely.
# see: http://stackoverflow.com/questions/7250659/python-code-to-generate-part-of-sphinx-documentation-is-it-possible/18143318#18143318
try:
    from StringIO import StringIO
except ImportError:
    from io import StringIO

Example #10

File: conf.py Project: gauravkaila/bob.palmvein

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'palmveinreclib', u'PalmveinRecLib Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation([
  'python', 'numpy', 'scipy', 'gridtk',
  'bob.extension', 'bob.math', 'bob.io.base', 'bob.ip.base', 'bob.ip.gabor', 'bob.learn.linear', 'bob.learn.misc', 'facereclib'
  'bob.db.verification.utils', 'bob.db.verification.filelist', 
  'bob.db.vera', 'bob.db.utfvp'
])


def setup(app):
  pass

Example #11

File: conf.py Project: SUNYOTECH/bob.palmvein

# If false, no module index is generated.
#latex_domain_indices = True

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'palmveinreclib', u'PalmveinRecLib Documentation',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation([
    'python', 'numpy', 'scipy', 'gridtk', 'bob.extension', 'bob.math',
    'bob.io.base', 'bob.ip.base', 'bob.ip.gabor', 'bob.learn.linear',
    'bob.learn.misc', 'facereclib'
    'bob.db.verification.utils', 'bob.db.verification.filelist', 'bob.db.vera',
    'bob.db.utfvp'
])


def setup(app):
    pass

Example #12

File: conf.py Project: 183amir/bob.db.nist_sre12

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'NIST Speaker Recognition Evaluation 2012 Database (Bob API) Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'bob.db.base', 'bob.db.verification.utils', 'spear', 'xspear.nist_sre12'])


def setup(app):
  pass

Example #13

File: conf.py Project: rishitech007/bob.db.nist_sre12

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(
    'index', 'bob',
    u'NIST Speaker Recognition Evaluation 2012 Database (Bob API) Documentation',
    [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation([
    'python', 'bob.db.base', 'bob.db.verification.utils', 'spear',
    'xspear.nist_sre12'
])


def setup(app):
    pass

Example #14

File: conf.py Project: bioidiap/bob.db.nist_sre12

# Default processing flags for sphinx
autoclass_content = 'class'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
  'members',
  'undoc-members',
  'show-inheritance',
  ]

# For inter-documentation mapping:
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=['python','numpy'] + \
          load_requirements(sphinx_requirements)
          )
else:
  intersphinx_mapping = link_documentation()


# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions = ['__array__']

def member_function_test(app, what, name, obj, skip, options):
  # test if we have a private function
  if len(name) > 1 and name[0] == '_':
    # test if this private function should be allowed
    if name not in accepted_private_functions:
      # omit privat functions that are not in the list of accepted private functions

Example #15

File: conf.py Project: honghuCode/bob.ip.facedetect

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bob.ip.facedetect',
              u'Documentation for the face detection library',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(
    ['python', 'numpy', 'scipy', 'matplotlib', 'bob.db.verification.utils'])


def setup(app):
    pass

Example #16

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.example.library', u'Bob Example Library Documentation',
     [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation()


def setup(app):
    pass

Example #17

File: conf.py Project: 183amir/bob.extension

.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob_extension', u'Bob Extension Building Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
  'members',
  'undoc-members',
  'inherited-members',
  'show-inheritance',
  ]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(additional_packages = ['python', 'bob.blitz', 'bob.db.base'])


def setup(app):
  pass

Example #18

# Output file base name for HTML help builder.
htmlhelp_basename = project_variable + u'_doc'

# -- Post configuration --------------------------------------------------------

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version, )

# Default processing flags for sphinx
autoclass_content = 'class'
autodoc_member_order = 'bysource'
autodoc_default_options = {
    "members": True,
    "show-inheritance": True,
}

# For inter-documentation mapping:
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=['python','numpy'] + \
            load_requirements(sphinx_requirements)
            )
else:
    intersphinx_mapping = link_documentation()

Example #19

File: conf.py Project: 183amir/bob.db.casia_fasd

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'CASIA Face Anti-Spoofing Database (Bob API) Documentation', [u'Idiap Research Institute'], 1)
]


# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'antispoofing.utils'])


def setup(app):
  pass

Example #20

File: conf.py Project: DavidDJChen/bob

#latex_domain_indices = True

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'Bob/Python Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(additional_packages = ['python', 'numpy', 'scipy', 'gridtk'], requirements_file = None)


def setup(app):
  pass

Example #21

File: conf.py Project: 183amir/antispoofing.utils

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'Antispoofing.utils', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'bob.extension'])


def setup(app):
  pass

Example #22

File: conf.py Project: 183amir/bob.db.avspoof

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'AVspoof (Bob API) Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'bob.db.base', 'bob.db.verification.utils', 'antispoofing.utils', 'bob.spear'])


def setup(app):
  pass

Example #23

File: conf.py Project: rllewell/bob

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version, )

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bob', u'Bob/Python Documentation',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(
    additional_packages=['python', 'numpy', 'scipy', 'gridtk'],
    requirements_file=None)

#import shutil
#shutil.rmtree(temp_dir)

Example #24

File: conf.py Project: tiagofrepereira2012/bob.db.celeba

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob', u'Celeb-A Database (Bob API) Documentation', [u'VaST Lab'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['bob.ip.base'])


def setup(app):
  pass

Example #25

File: conf.py Project: bioidiap/docs

# Default processing flags for sphinx
autoclass_content = "class"
autodoc_member_order = "bysource"
autodoc_default_options = {
    "members": True,
    "undoc-members": True,
    "show-inheritance": True,
}

# For inter-documentation mapping:
from bob.extension.utils import link_documentation

sphinx_requirements = "extra-intersphinx.txt"
if os.path.exists(sphinx_requirements):
    intersphinx_mapping = link_documentation(
        requirements_file=sphinx_requirements)
else:
    intersphinx_mapping = link_documentation(requirements_file=None)

# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions = ["__array__"]


def member_function_test(app, what, name, obj, skip, options):
    # test if we have a private function
    if len(name) > 1 and name[0] == "_":
        # test if this private function should be allowed
        if name not in accepted_private_functions:
            # omit privat functions that are not in the list of accepted private functions
            return skip

Example #26

File: conf.py Project: lydonchandra/bob.bio.face

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.bio.face', u'Run Face Recognition Experiments with bob.bio',
     [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(
    ['python', 'numpy', 'bob.bio.gmm', 'bob.bio.csu', 'bob.db.lfw'])


def skip(app, what, name, obj, skip, options):
    # Do not skip the __call__ function as we have special implementations for them.
    if name in ("__call__"):
        return False
    return skip


def setup(app):
    app.connect("autodoc-skip-member", skip)

Example #27

File: conf.py Project: 183amir/bob.db.iris

#latex_domain_indices = True

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob_db_iris', u'Bob Database Support Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.db.base', 'bob.learn.linear', 'bob.measure'])


def setup(app):
  pass

Example #28

File: conf.py Project: umtcsgn/facereclib

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'facereclib', u'FaceRecLib Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation([
  'python', 'numpy', 'scipy', 'gridtk',
  'bob.extension', 'bob.math', 'bob.io.base', 'bob.ip.base', 'bob.ip.gabor', 'bob.learn.linear', 'bob.learn.em',
  'bob.db.verification.utils', 'bob.db.verification.filelist', 'bob.db.atnt',
  'bob.db.arface', 'bob.db.caspeal', 'bob.db.frgc', 'bob.db.gbu', 'bob.db.lfw', 'bob.db.banca', 'bob.db.mobio', 'bob.db.multipie', 'bob.db.scface', 'bob.db.xm2vts'
])


def setup(app):
  pass

Example #29

File: conf.py Project: luukhoavn/bob.db.ijba

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True

# Included after all input documents
rst_epilog = ""

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ("index", "bob", u"JANUS Database (Bob API) Documentation", [u"University of Colorado in Colorado Springs"], 1)
]

# Default processing flags for sphinx
autoclass_content = "both"
autodoc_member_order = "bysource"
autodoc_default_flags = ["members", "undoc-members", "inherited-members", "show-inheritance"]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation

intersphinx_mapping = link_documentation(["python", "bob.db.base", "bob.db.verification.utils"])


def setup(app):
    pass

Example #30

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.example.project', u'Bob Example Project Documentation',
     [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(
    ['python', 'numpy', 'bob.io.base', 'bob.db.verification.utils'])


def setup(app):
    pass

Example #31

File: conf.py Project: 183amir/bob.db.verification.utils

rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.db.verification.utils', u'Bob\'s Verification Database Utilities Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'bob.db.base', \
  'bob.db.arface', 'bob.db.atnt', 'bob.db.biosecure', 'bob.db.caspeal', 'bob.db.frgc', 'bob.db.gbu', 'bob.db.lfw', 'bob.db.scface', 'bob.db.xm2vts', 'bob.db.youtube',\
  'bob.db.banca', 'bob.db.mobio', 'bob.db.multipie', 'bob.db.nist_sre12', 'bob.db.voxforge', 'bob.db.verification.filelist'
])


def setup(app):
  pass

Example #32

File: conf.py Project: bioidiap/bob.learn.linear

""" % (version,)

# Default processing flags for sphinx
autoclass_content = 'class'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
  'members',
  'undoc-members',
  'show-inheritance',
  ]

# For inter-documentation mapping:
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))
else:
    intersphinx_mapping = link_documentation()


# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions = ['__array__']

def member_function_test(app, what, name, obj, skip, options):
  # test if we have a private function
  if len(name) > 1 and name[0] == '_':
    # test if this private function should be allowed
    if name not in accepted_private_functions:
      # omit privat functions that are not in the list of accepted private functions
      return skip

Example #33

File: conf.py Project: 183amir/bob.bio.gmm

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.bio.gmm', u'Gaussian Mixture Models in bob.bio Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.io.gmm'])


def skip(app, what, name, obj, skip, options):
  # Do not skip the __call__ and the __str__ functions as we have special implementations for them.
  if name in ("__call__"):
    return False
  return skip

def setup(app):
  app.connect("autodoc-skip-member", skip)

Example #34

File: conf.py Project: tiagofrepereira2012/bob.learn.boosting

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.project.example', u'Bob Project Example Documentation', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'scipy'])


def setup(app):
  pass

Example #35

File: conf.py Project: tiagofrepereira2012/bob.bio.gmm

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bob.bio.gmm',
              u'Gaussian Mixture Models in bob.bio Documentation',
              [u'Idiap Research Institute'], 1)]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members', 'undoc-members', 'inherited-members', 'show-inheritance'
]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.io.gmm'])


def skip(app, what, name, obj, skip, options):
    # Do not skip the __call__ and the __str__ functions as we have special implementations for them.
    if name in ("__call__"):
        return False
    return skip


def setup(app):
    app.connect("autodoc-skip-member", skip)

Example #36

File: conf.py Project: 183amir/bob.ip.gabor

#latex_domain_indices = True

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob_ip_draw', u'Bob\'s Gabor Wavelet Support and Utilities', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation()


def setup(app):
  pass

Example #37

File: conf.py Project: pkorshunov/bob.ap

# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (
    version,
)

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [("index", "bob_ap", u"Bob Audio Processing Documentation", [u"Idiap Research Institute"], 1)]

# Default processing flags for sphinx
autoclass_content = "both"
autodoc_member_order = "bysource"
autodoc_default_flags = ["members", "undoc-members", "inherited-members", "show-inheritance"]

# For inter-documentation mapping:
from bob.extension.utils import link_documentation

intersphinx_mapping = link_documentation(["python", "numpy", "scipy", "pysox"])


def setup(app):
    pass

Example #38

File: conf.py Project: vae203/bob.bio.base

# Default processing flags for sphinx
autoclass_content = 'class'
autodoc_member_order = 'bysource'
autodoc_default_flags = [
    'members',
    'undoc-members',
    'show-inheritance',
]

# For inter-documentation mapping:
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))
else:
    intersphinx_mapping = link_documentation()

# We want to remove all private (i.e. _. or __.__) members
# that are not in the list of accepted functions
accepted_private_functions = ['__array__']


def member_function_test(app, what, name, obj, skip, options):
    # test if we have a private function
    if len(name) > 1 and name[0] == '_':
        # test if this private function should be allowed
        if name not in accepted_private_functions:
            # omit privat functions that are not in the list of accepted private functions
            return skip

Example #39

File: conf.py Project: 183amir/bob.bio.face

# Included after all input documents
rst_epilog = ''

# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'bob.bio.face', u'Run Face Recognition Experiments with bob.bio', [u'Idiap Research Institute'], 1)
]

# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'inherited-members', 'show-inheritance']

# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.bio.gmm', 'bob.bio.csu', 'bob.db.lfw'])


def skip(app, what, name, obj, skip, options):
  # Do not skip the __call__ function as we have special implementations for them.
  if name in ("__call__"):
    return False
  return skip

def setup(app):
  app.connect("autodoc-skip-member", skip)