diff --git a/doc/conf.py b/doc/conf.py index af7c2bcd5d614fe418092f2eca6ed58dcf1b0a04..038d0a213eb4b6b095e4e198c173ccaa349d1f48 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -59,12 +59,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'xbob.machine' +project = u'xbob.learn.activation' import time copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') # Grab the setup entry -distribution = pkg_resources.require('xbob.machine')[0] +distribution = pkg_resources.require('xbob.learn.activation')[0] # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -130,7 +130,7 @@ if sphinx.__version__ >= "1.0": #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = 'xbob_machine' +#html_short_title = 'xbob_learn_activation' # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -188,7 +188,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'xbob_machine_doc' +htmlhelp_basename = 'xbob_learn_activation_doc' # -- Options for LaTeX output -------------------------------------------------- @@ -202,7 +202,7 @@ latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'xbob_machine.tex', u'Bob Machines', + ('index', 'xbob_learn_activation.tex', u'Bob Activation Functions', u'Biometrics Group, Idiap Research Institute', 'manual'), ] @@ -242,7 +242,7 @@ rst_epilog = """ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'xbob_machine', u'Bob Machines Documentation', [u'Idiap Research Institute'], 1) + ('index', 'xbob_learn_activation', u'Bob Activation Function Documentation', [u'Idiap Research Institute'], 1) ] # Default processing flags for sphinx diff --git a/xbob/learn/activation/__init__.py b/xbob/learn/activation/__init__.py index 2bf07dc76f0be5a1709cf8f0264bff869b4cea2d..b66dfe3cedc055640aa600c1144610f7baa25a4d 100644 --- a/xbob/learn/activation/__init__.py +++ b/xbob/learn/activation/__init__.py @@ -5,3 +5,7 @@ def get_include(): """Returns the directory containing the C/C++ API include directives""" return __import__('pkg_resources').resource_filename(__name__, 'include') + +# gets sphinx autodoc done right - don't remove it +__all__ = [k for k in dir() if not k.startswith('_')] +del k