Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
bob.bio.face
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
bob
bob.bio.face
Commits
94deb52c
Commit
94deb52c
authored
9 years ago
by
Manuel Günther
Browse files
Options
Downloads
Patches
Plain Diff
Added documentation files (not adding doc yet)
parent
56fd69aa
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
doc/conf.py
+253
-0
253 additions, 0 deletions
doc/conf.py
doc/index.rst
+18
-0
18 additions, 0 deletions
doc/index.rst
with
271 additions
and
0 deletions
doc/conf.py
0 → 100644
+
253
−
0
View file @
94deb52c
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
# Andre Anjos <andre.anjos@idiap.ch>
# Mon 13 Aug 2012 12:38:15 CEST
#
# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland
import
os
import
sys
import
glob
import
pkg_resources
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions
=
[
'
sphinx.ext.todo
'
,
'
sphinx.ext.coverage
'
,
'
sphinx.ext.pngmath
'
,
'
sphinx.ext.ifconfig
'
,
'
sphinx.ext.autodoc
'
,
'
sphinx.ext.autosummary
'
,
'
sphinx.ext.doctest
'
,
'
sphinx.ext.intersphinx
'
,
]
# The viewcode extension appeared only on Sphinx >= 1.0.0
import
sphinx
if
sphinx
.
__version__
>=
"
1.0
"
:
extensions
.
append
(
'
sphinx.ext.viewcode
'
)
# Always includes todos
todo_include_todos
=
True
# If we are on OSX, the 'dvipng' path maybe different
dvipng_osx
=
'
/opt/local/libexec/texlive/binaries/dvipng
'
if
os
.
path
.
exists
(
dvipng_osx
):
pngmath_dvipng
=
dvipng_osx
# Add any paths that contain templates here, relative to this directory.
templates_path
=
[
'
_templates
'
]
# The suffix of source filenames.
source_suffix
=
'
.rst
'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc
=
'
index
'
# General information about the project.
project
=
u
'
Bob Example Project
'
import
time
copyright
=
u
'
%s, Idiap Research Institute
'
%
time
.
strftime
(
'
%Y
'
)
# Grab the setup entry
distribution
=
pkg_resources
.
require
(
'
bob.bio.face
'
)[
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
# built documents.
#
# The short X.Y version.
version
=
distribution
.
version
# The full version, including alpha/beta/rc tags.
release
=
distribution
.
version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
#exclude_patterns = ['**/links.rst']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style
=
'
sphinx
'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
if
sphinx
.
__version__
>=
"
1.0
"
:
html_theme
=
'
nature
'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = 'bob'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo
=
''
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon
=
''
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename
=
'
bob_example_project_doc
'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
latex_paper_size
=
'
a4
'
# The font size ('10pt', '11pt' or '12pt').
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
'
,
'
bob_example_project.tex
'
,
u
'
Bob
'
,
u
'
Biometrics Group, Idiap Research Institute
'
,
'
manual
'
),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo
=
''
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# 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.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
This diff is collapsed.
Click to expand it.
doc/index.rst
0 → 100644
+
18
−
0
View file @
94deb52c
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
.. Mon 13 Aug 2012 12:36:40 CEST
=====================
Bob Example Project
=====================
Package Documentation
---------------------
.. automodule:: bob.bio.face
Databases
---------
.. automodule:: bob.bio.face.database
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment