Commit a4f287f6 authored by André Anjos's avatar André Anjos 💬
Browse files

Fix documentation generation

parent d93be0a8
......@@ -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
......
......@@ -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
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