Skip to content
Snippets Groups Projects
Commit 41342c2b authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

Updated documentation

parent dd46aec6
No related branches found
No related tags found
No related merge requests found
...@@ -2,9 +2,9 @@ ...@@ -2,9 +2,9 @@
.. Andre Anjos <andre.anjos@idiap.ch> .. Andre Anjos <andre.anjos@idiap.ch>
.. Thu 29 Aug 2013 16:07:57 CEST .. Thu 29 Aug 2013 16:07:57 CEST
============================ ==================================
Python bindings for bob.db Python bindings for xbob.db.base
============================ ==================================
This package contains a set of Pythonic bindings for Bob's database packages This package contains a set of Pythonic bindings for Bob's database packages
and functionality. and functionality.
...@@ -31,7 +31,7 @@ Testing ...@@ -31,7 +31,7 @@ Testing
You can run a set of tests using the nose test runner:: You can run a set of tests using the nose test runner::
$ nosetests -sv xbob.db $ nosetests -sv xbob.db.base
.. warning:: .. warning::
...@@ -48,7 +48,7 @@ You can run our documentation tests using sphinx itself:: ...@@ -48,7 +48,7 @@ You can run our documentation tests using sphinx itself::
You can test overall test coverage with:: You can test overall test coverage with::
$ nosetests --with-coverage --cover-package=xbob.db $ nosetests --with-coverage --cover-package=xbob.db.base
The ``coverage`` egg must be installed for this to work properly. The ``coverage`` egg must be installed for this to work properly.
......
...@@ -59,12 +59,12 @@ source_suffix = '.rst' ...@@ -59,12 +59,12 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'xbob.db' project = u'xbob.db.base'
import time import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
# Grab the setup entry # Grab the setup entry
distribution = pkg_resources.require('xbob.db')[0] distribution = pkg_resources.require('xbob.db.base')[0]
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
...@@ -130,7 +130,7 @@ if sphinx.__version__ >= "1.0": ...@@ -130,7 +130,7 @@ if sphinx.__version__ >= "1.0":
#html_title = None #html_title = None
# A shorter title for the navigation bar. Default is the same as html_title. # A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = 'xbob_db' #html_short_title = 'xbob_db_base'
# The name of an image file (relative to this directory) to place at the top # The name of an image file (relative to this directory) to place at the top
# of the sidebar. # of the sidebar.
...@@ -188,7 +188,7 @@ html_static_path = ['_static'] ...@@ -188,7 +188,7 @@ html_static_path = ['_static']
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'xbob_db_doc' htmlhelp_basename = 'xbob_db_base_doc'
# -- Options for LaTeX output -------------------------------------------------- # -- Options for LaTeX output --------------------------------------------------
...@@ -202,7 +202,7 @@ latex_font_size = '10pt' ...@@ -202,7 +202,7 @@ latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'xbob_db.tex', u'Bob Database Support Documentation', ('index', 'xbob_db_base.tex', u'Bob Database Support Documentation',
u'Biometrics Group, Idiap Research Institute', 'manual'), u'Biometrics Group, Idiap Research Institute', 'manual'),
] ]
...@@ -239,7 +239,7 @@ rst_epilog = """ ...@@ -239,7 +239,7 @@ rst_epilog = """
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'xbob_db', u'Bob Database Support Documentation', [u'Idiap Research Institute'], 1) ('index', 'xbob_db_base', u'Bob Database Support Documentation', [u'Idiap Research Institute'], 1)
] ]
# Default processing flags for sphinx # Default processing flags for sphinx
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment