diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..c37fbe29b41e8e23ccbf09f543fba371a2135c43 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,253 @@ +# This build file is defined in two parts: 1) a generic set of instructions you +# probably **don't** need to change and 2) a part you may have to tune to your +# project. It heavily uses template features from YAML to help you in only +# changing a minimal part of it and avoid code duplication to a maximum while +# still providing a nice pipeline display on your package. + + +# 1) Generic instructions (only change if you know what you're doing) +# ------------------------------------------------------------------- + +# Definition of our build pipeline +stages: + - build + - test + - docs + - wheels + + +# Global variables +variables: + CONDA_PREFIX: env + + +# Template for the build stage +# Needs to run on all supported architectures, platforms and python versions +.build_template: &build_job + stage: build + before_script: + - git clean -ffdx + - curl --silent https://gitlab.idiap.ch/bob/bob/snippets/7/raw | tr -d '\r' > bootstrap-conda.sh + - chmod 755 ./bootstrap-conda.sh + - ./bootstrap-conda.sh ${CONDA_FOLDER} ${PYTHON_VER} ${CONDA_PREFIX} + variables: &build_variables + BOB_DOCUMENTATION_SERVER: "http://www.idiap.ch/software/bob/docs/latest/bob/%s/master/" + script: + - ./bin/buildout + - ./bin/sphinx-build doc sphinx + - ./bin/python setup.py bdist_wheel --python-tag ${WHEEL_TAG} + after_script: + - rm -rf ${CONDA_PREFIX} + artifacts: + expire_in: 1 day + paths: + - bootstrap-conda.sh + - dist/ + - sphinx/ + + +# Template for building on a Linux machine +.build_linux_template: &linux_build_job + <<: *build_job + variables: &linux_build_variables + <<: *build_variables + CONDA_FOLDER: "/local/conda" + CFLAGS: "-D_GLIBCXX_USE_CXX11_ABI=0 -coverage" + CXXFLAGS: "-D_GLIBCXX_USE_CXX11_ABI=0 -coverage" + + +# Template for building on a Mac OSX machine +.build_mac_template: &macosx_build_job + <<: *build_job + variables: &macosx_build_variables + <<: *build_variables + CONDA_FOLDER: "/opt/conda" + MACOSX_DEPLOYMENT_TARGET: "10.9" + CFLAGS: "-pthread -coverage" + CXXFLAGS: "-pthread -coverage" + LDFLAGS: "-lpthread" + + +# Template for the test stage - re-install from uploaded wheels +# Needs to run on all supported architectures, platforms and python versions +.test_template: &test_job + stage: test + before_script: + - ./bootstrap-conda.sh ${CONDA_FOLDER} ${PYTHON_VER} ${CONDA_PREFIX} + - source ${CONDA_FOLDER}/bin/activate ${CONDA_PREFIX} + - pip install --use-wheel --no-index --pre dist/*.whl + script: + - cd ${CONDA_PREFIX} + - python -c "from ${CI_PROJECT_NAME} import get_config; print(get_config())" + - coverage run --source=${CI_PROJECT_NAME} ./bin/nosetests -sv ${CI_PROJECT_NAME} + - coverage report + - sphinx-build -b doctest ../doc ../sphinx + after_script: + - rm -rf ${CONDA_PREFIX} + + +# Template for the wheel uploading stage +# Needs to run against one combination of python 2.x and 3.x if it is a python +# only package, otherwise, needs to run in both pythons to all supported +# architectures (Linux and Mac OSX 64-bit) +.wheels_template: &wheels_job + stage: wheels + only: + - master + - tags + before_script: + - curl --silent https://gitlab.idiap.ch/bob/bob/snippets/8/raw | tr -d '\r' > upload-wheel.sh + - chmod 755 upload-wheel.sh + script: + - ./upload-wheel.sh + + +# Template for (latest) documentation upload stage +# Only one real job needs to do this +.docs_template: &docs_job + stage: docs + only: + - master + before_script: + - curl --silent https://gitlab.idiap.ch/bob/bob/snippets/9/raw | tr -d '\r' > upload-sphinx.sh + - chmod 755 upload-sphinx.sh + script: + - ./upload-sphinx.sh + + +# 2) Package specific instructions (you may tune this if needed) +# -------------------------------------------------------------- + +# Linux + Python 2.7: Builds, tests, uploads wheel +build_linux_27: + <<: *linux_build_job + variables: &linux_27_build_variables + <<: *linux_build_variables + PYTHON_VER: "2.7" + WHEEL_TAG: "py27" + tags: + - conda-linux + +test_linux_27: + <<: *test_job + variables: *linux_27_build_variables + dependencies: + - build_linux_27 + tags: + - conda-linux + +wheels_linux_27: + <<: *wheels_job + dependencies: + - build_linux_27 + tags: + - conda-linux + + +# Linux + Python 3.4: Builds and tests +build_linux_34: + <<: *linux_build_job + variables: &linux_34_build_variables + <<: *linux_build_variables + PYTHON_VER: "3.4" + WHEEL_TAG: "py3" + tags: + - conda-linux + +test_linux_34: + <<: *test_job + variables: *linux_34_build_variables + dependencies: + - build_linux_34 + tags: + - conda-linux + + +# Linux + Python 3.5: Builds, tests, uploads wheel +build_linux_35: + <<: *linux_build_job + variables: &linux_35_build_variables + <<: *linux_build_variables + PYTHON_VER: "3.5" + WHEEL_TAG: "py3" + tags: + - conda-linux + +test_linux_35: + <<: *test_job + variables: *linux_35_build_variables + dependencies: + - build_linux_35 + tags: + - conda-linux + +wheels_linux_35: + <<: *wheels_job + dependencies: + - build_linux_35 + tags: + - conda-linux + +docs_linux_35: + <<: *docs_job + dependencies: + - build_linux_35 + tags: + - conda-linux + + +# Mac OSX + Python 2.7: Builds and tests +build_macosx_27: + <<: *macosx_build_job + variables: &macosx_27_build_variables + <<: *macosx_build_variables + PYTHON_VER: "2.7" + WHEEL_TAG: "py27" + tags: + - conda-macosx + +test_macosx_27: + <<: *test_job + variables: *macosx_27_build_variables + dependencies: + - build_macosx_27 + tags: + - conda-macosx + + +# Mac OSX + Python 3.4: Builds and tests +build_macosx_34: + <<: *macosx_build_job + variables: &macosx_34_build_variables + <<: *macosx_build_variables + PYTHON_VER: "3.4" + WHEEL_TAG: "py3" + tags: + - conda-macosx + +test_macosx_34: + <<: *test_job + variables: *macosx_34_build_variables + dependencies: + - build_macosx_34 + tags: + - conda-macosx + + +# Mac OSX + Python 3.5: Builds and tests +build_macosx_35: + <<: *macosx_build_job + variables: &macosx_35_build_variables + <<: *macosx_build_variables + PYTHON_VER: "3.5" + WHEEL_TAG: "py3" + tags: + - conda-macosx + +test_macosx_35: + <<: *test_job + variables: *macosx_35_build_variables + dependencies: + - build_macosx_35 + tags: + - conda-macosx \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8c6c1744d58a4ddd74a1aa01c46d9614a47aff19..0000000000000000000000000000000000000000 --- a/.travis.yml +++ /dev/null @@ -1,33 +0,0 @@ -language: python -matrix: - include: - - python: 2.7 - env: - - secure: IsIuB+1cKlkdqXxNmAGp/me3JrYcuTzrZVcP2x9XWsJR43AW7jlPet9fB1lsU6pzfymCww3eody+J4ZiTcKWjL91BLHLNbBcny6EdzwZzdt26sH7moF53WEe678bwcmrkBEDbbaTODPKJDKFNHWy2QjBd46KzFBsvUBMzPL8skA= - - secure: RyfuwYiUnkICmUMqV/oV1X0rckwa3FHxwt2zCf/uDPzQitccXf64byZp+yh6Va1epIc4pLXZ4nI2UBg2P222Q7xjOciXJShQZAXANeajhIfoLdC/mM/TvwJLOqviFrSh2fJlnuj1/Rwya3yhW0fkDlwJjyoc7vrJthIy1wgRExo= - - BOB_DOCUMENTATION_SERVER=https://www.idiap.ch/software/bob/docs/latest/bioidiap/%s/master - - BOB_UPLOAD_WHEEL="--universal" - - python: 3.3 - - python: 3.4 - - python: 3.5 -before_install: -- sudo add-apt-repository -y ppa:biometrics/bob -- sudo apt-get update -qq -- sudo apt-get install -qq --force-yes libboost-all-dev libblitz1-dev libhdf5-serial-dev libatlas-dev libatlas-base-dev liblapack-dev texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended -- pip install --upgrade pip -- pip install --find-links https://www.idiap.ch/software/bob/wheels/travis/ --use-wheel sphinx nose numpy coverage -- pip install --find-links https://www.idiap.ch/software/bob/wheels/travis/ --use-wheel --pre -r requirements.txt coveralls -install: -- python bootstrap-buildout.py -- ./bin/buildout buildout:develop=. buildout:extensions=bob.buildout buildout:auto-checkout= -script: -- ./bin/python -c 'import pkg_resources; from bob.db.atnt import get_config; print(get_config())' -- ./bin/coverage run --source=bob.db.atnt ./bin/nosetests -sv -- ./bin/sphinx-build -b doctest doc sphinx -- ./bin/sphinx-build -b html doc sphinx -after_success: -- coveralls -- wget https://raw.githubusercontent.com/bioidiap/bob.extension/master/scripts/upload-{sphinx,wheel}.sh -- chmod a+x upload-sphinx.sh upload-wheel.sh -- ./upload-sphinx.sh -- ./upload-wheel.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..dced67ea1874ec17f6eeb6a4a928c42d359202b7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ +Written by Manuel Guenther <manuel.guenther@idiap.ch> + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation +and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its contributors +may be used to endorse or promote products derived from this software without +specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/MANIFEST.in b/MANIFEST.in index 609678cbd69816909ef1c38625dad75ca6cabfd6..d497715a0b49335bf3a399bb8412d76d959dc72f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,2 @@ -include README.rst bootstrap-buildout.py buildout.cfg version.txt requirements.txt +include README.rst bootstrap-buildout.py buildout.cfg develop.cfg version.txt requirements.txt recursive-include doc *.py *.rst diff --git a/README.rst b/README.rst index 81859b8c70166edab24d203b1c4b8d5d95547159..ba8b06dac88fc3409b370a795fbfd3eefffaa817 100644 --- a/README.rst +++ b/README.rst @@ -1,44 +1,50 @@ .. vim: set fileencoding=utf-8 : -.. Manuel Guenther <manuel.guenther@idiap.ch> -.. Fri Oct 31 14:18:57 CET 2014 +.. Tue 16 Aug 11:17:03 CEST 2016 .. image:: http://img.shields.io/badge/docs-stable-yellow.png :target: http://pythonhosted.org/bob.db.atnt/index.html .. image:: http://img.shields.io/badge/docs-latest-orange.png :target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.atnt/master/index.html -.. image:: https://travis-ci.org/bioidiap/bob.db.atnt.svg?branch=master - :target: https://travis-ci.org/bioidiap/bob.db.atnt -.. image:: https://coveralls.io/repos/bioidiap/bob.db.atnt/badge.svg - :target: https://coveralls.io/r/bioidiap/bob.db.atnt -.. image:: https://img.shields.io/badge/github-master-0000c0.png - :target: https://github.com/bioidiap/bob.db.atnt/tree/master +.. image:: https://gitlab.idiap.ch/bob/bob.db.atnt/badges/master/build.svg + :target: https://gitlab.idiap.ch/bob/bob.db.atnt/commits/master +.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg + :target: https://gitlab.idiap.ch/bob/bob.db.atnt .. image:: http://img.shields.io/pypi/v/bob.db.atnt.png :target: https://pypi.python.org/pypi/bob.db.atnt .. image:: http://img.shields.io/pypi/dm/bob.db.atnt.png :target: https://pypi.python.org/pypi/bob.db.atnt -.. image:: https://img.shields.io/badge/original-data--files-a000a0.png - :target: http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html + ================================= AT&T Database Interface for Bob ================================= -This package contains an interface for the evaluation protocol of the `AT&T`_ database, formerly known as the ORL database of faces. -This package does not contain the original `AT&T`_ data files, which need to be obtained through the link above. +This package is part of the signal-processing and machine learning toolbox +Bob_. It contains an interface for the evaluation protocol of the `AT&T`_ +database, formerly known as the ORL database of faces. This package does not +contain the original `AT&T`_ data files, which need to be obtained through the +link above. Installation ------------ -To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_. -For Bob_ to be able to work properly, some dependent packages are required to be installed. -Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system. -Documentation -------------- -For further documentation on this package, please read the `Stable Version <http://pythonhosted.org/bob.db.atnt/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.db.atnt/master/index.html>`_ of the documentation. -For a list of tutorials on this or the other packages ob Bob_, or information on submitting issues, asking questions and starting discussions, please visit its website. +Follow our `installation`_ instructions. Then, using the Python interpreter +provided by the distribution, bootstrap and buildout this package:: + + $ python bootstrap-buildout.py + $ ./bin/buildout -.. _bob: https://www.idiap.ch/software/bob -.. _at&t: http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html +Contact +------- +For questions or reporting issues to this software package, contact our +development `mailing list`_. + + +.. Place your references here: +.. _bob: https://www.idiap.ch/software/bob +.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation +.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel +.. _at&t: http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html diff --git a/bootstrap-buildout.py b/bootstrap-buildout.py index a629566735c1c84fbec7173f0f30015b2b432512..a4599211f741c468cd37a29861d1c7f2c3a641d1 100644 --- a/bootstrap-buildout.py +++ b/bootstrap-buildout.py @@ -25,7 +25,10 @@ import tempfile from optparse import OptionParser -tmpeggs = tempfile.mkdtemp() +__version__ = '2015-07-01' +# See zc.buildout's changelog if this version is up to date. + +tmpeggs = tempfile.mkdtemp(prefix='bootstrap-') usage = '''\ [DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options] @@ -40,8 +43,9 @@ this script from going over the network. ''' parser = OptionParser(usage=usage) -parser.add_option("-v", "--version", help="use a specific zc.buildout version") - +parser.add_option("--version", + action="store_true", default=False, + help=("Return bootstrap.py version.")) parser.add_option("-t", "--accept-buildout-test-releases", dest='accept_buildout_test_releases', action="store_true", default=False, @@ -59,25 +63,33 @@ parser.add_option("-f", "--find-links", parser.add_option("--allow-site-packages", action="store_true", default=False, help=("Let bootstrap.py use existing site packages")) +parser.add_option("--buildout-version", + help="Use a specific zc.buildout version") parser.add_option("--setuptools-version", - help="use a specific setuptools version") - + help="Use a specific setuptools version") +parser.add_option("--setuptools-to-dir", + help=("Allow for re-use of existing directory of " + "setuptools versions")) options, args = parser.parse_args() +if options.version: + print("bootstrap.py version %s" % __version__) + sys.exit(0) + ###################################################################### # load/install setuptools try: - if options.allow_site_packages: - import setuptools - import pkg_resources from urllib.request import urlopen except ImportError: from urllib2 import urlopen ez = {} -exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) +if os.path.exists('ez_setup.py'): + exec(open('ez_setup.py').read(), ez) +else: + exec(urlopen('https://bootstrap.pypa.io/ez_setup.py').read(), ez) if not options.allow_site_packages: # ez_setup imports site, which adds site packages @@ -88,12 +100,19 @@ if not options.allow_site_packages: # We can't remove these reliably if hasattr(site, 'getsitepackages'): for sitepackage_path in site.getsitepackages(): - sys.path[:] = [x for x in sys.path if sitepackage_path not in x] + # Strip all site-packages directories from sys.path that + # are not sys.prefix; this is because on Windows + # sys.prefix is a site-package directory. + if sitepackage_path != sys.prefix: + sys.path[:] = [x for x in sys.path + if sitepackage_path not in x] setup_args = dict(to_dir=tmpeggs, download_delay=0) if options.setuptools_version is not None: setup_args['version'] = options.setuptools_version +if options.setuptools_to_dir is not None: + setup_args['to_dir'] = options.setuptools_to_dir ez['use_setuptools'](**setup_args) import setuptools @@ -110,7 +129,12 @@ for path in sys.path: ws = pkg_resources.working_set +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +# Fix sys.path here as easy_install.pth added before PYTHONPATH cmd = [sys.executable, '-c', + 'import sys; sys.path[0:0] = [%r]; ' % setuptools_path + 'from setuptools.command.easy_install import main; main()', '-mZqNxd', tmpeggs] @@ -123,11 +147,8 @@ find_links = os.environ.get( if find_links: cmd.extend(['-f', find_links]) -setuptools_path = ws.find( - pkg_resources.Requirement.parse('setuptools')).location - requirement = 'zc.buildout' -version = options.version +version = options.buildout_version if version is None and not options.accept_buildout_test_releases: # Figure out the most recent final version of zc.buildout. import setuptools.package_index @@ -167,7 +188,7 @@ if version: cmd.append(requirement) import subprocess -if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: +if subprocess.call(cmd) != 0: raise Exception( "Failed to execute command:\n%s" % repr(cmd)[1:-1]) diff --git a/buildout.cfg b/buildout.cfg index 05a83ddac362cdd3958102dfcafb6d735b17b1d8..9d624bbcfd322ff879394ff0fffc0d785751cd13 100644 --- a/buildout.cfg +++ b/buildout.cfg @@ -1,32 +1,13 @@ ; vim: set fileencoding=utf-8 : -; Manuel Guenther <manuel.guenther@idiap.ch> -; Mon Aug 25 15:58:39 CEST 2014 +; Tue 16 Aug 11:17:03 CEST 2016 [buildout] parts = scripts +develop = . eggs = bob.db.atnt extensions = bob.buildout - mr.developer -auto-checkout = * -develop = src/bob.extension - src/bob.blitz - src/bob.core - src/bob.io.base - src/bob.db.base - . - -; options for bob.buildout extension -debug = true -verbose = true newest = false - -[sources] -bob.extension = git https://github.com/bioidiap/bob.extension -bob.blitz = git https://github.com/bioidiap/bob.blitz -bob.core = git https://github.com/bioidiap/bob.core -bob.io.base = git https://github.com/bioidiap/bob.io.base -bob.db.base = git https://github.com/bioidiap/bob.db.base +verbose = true [scripts] -recipe = bob.buildout:scripts -dependent-scripts=true +recipe = bob.buildout:scripts \ No newline at end of file diff --git a/develop.cfg b/develop.cfg new file mode 100644 index 0000000000000000000000000000000000000000..bdaf5afd29ac869e246c261154bde4bb7ea7fdc5 --- /dev/null +++ b/develop.cfg @@ -0,0 +1,32 @@ +; vim: set fileencoding=utf-8 : +; Manuel Guenther <manuel.guenther@idiap.ch> +; Mon Aug 25 15:58:39 CEST 2014 + +[buildout] +parts = scripts +eggs = bob.db.atnt +extensions = bob.buildout + mr.developer +auto-checkout = * +develop = src/bob.extension + src/bob.blitz + src/bob.core + src/bob.io.base + src/bob.db.base + . + +; options for bob.buildout extension +debug = true +verbose = true +newest = false + +[sources] +bob.extension = git https://gitlab.idiap.ch/bob/bob.extension +bob.blitz = git https://gitlab.idiap.ch/bob/bob.blitz +bob.core = git https://gitlab.idiap.ch/bob/bob.core +bob.io.base = git https://gitlab.idiap.ch/bob/bob.io.base +bob.db.base = git https://gitlab.idiap.ch/bob/bob.db.base + +[scripts] +recipe = bob.buildout:scripts +dependent-scripts=true diff --git a/doc/conf.py b/doc/conf.py index 3e63ab9d47bec838f6d8ae1c2220a2f78826e802..9c478625796c0d5394096ff5985cbede68fd3424 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,9 +1,5 @@ #!/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 @@ -11,38 +7,41 @@ 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' +needs_sphinx = '1.3' # 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', -# 'bob.sphinxext.plot', # ours add source copying to install directory - ] + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.graphviz', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.viewcode', + ] -# The viewcode extension appeared only on Sphinx >= 1.0.0 import sphinx -if sphinx.__version__ >= "1.0": - extensions.append('sphinx.ext.viewcode') +if sphinx.__version__ >= "1.4.1": + extensions.append('sphinx.ext.imgmath') +else: + extensions.append('sphinx.ext.pngmath') # Always includes todos todo_include_todos = True +# Generates auto-summary automatically +autosummary_generate = True + +# Create numbers on figures with captions +numfig = 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 @@ -60,12 +59,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'AT&T/ORL Database (Bob API)' +project = u'bob.db.atnt' import time copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') # Grab the setup entry -distribution = pkg_resources.require('bob.db.atnt')[0] +distribution = pkg_resources.require(project)[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 @@ -88,7 +87,7 @@ release = distribution.version # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['**/links.rst'] +exclude_patterns = ['links.rst'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -110,13 +109,18 @@ pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] +# Some variables which are useful for generated material +project_variable = project.replace('.', '_') +short_description = u'ATNT/ORL Database Access API for Bob' +owner = [u'Idiap Research Institute'] + # -- 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' +import sphinx_rtd_theme +html_theme = 'sphinx_rtd_theme' # 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 @@ -124,14 +128,14 @@ if sphinx.__version__ >= "1.0": #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_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' +#html_short_title = project_variable # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -189,67 +193,48 @@ html_favicon = 'img/favicon.ico' #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'bob_db_atnt_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_db_atnt.tex', u'Bob', - u'Biometrics Group, Idiap Research Institute', 'manual'), -] +htmlhelp_basename = project_variable + u'_doc' -# 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 +# -- Post configuration -------------------------------------------------------- # 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'AT&T/ORL Database (Bob API) Documentation', [u'Idiap Research Institute'], 1) -] +rst_epilog = """ +.. |project| replace:: Bob +.. |version| replace:: %s +.. |current-year| date:: %%Y +""" % (version,) # Default processing flags for sphinx -autoclass_content = 'both' +autoclass_content = 'class' autodoc_member_order = 'bysource' -autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance'] +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']) - +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 + else: + # test if the method is documented + if not hasattr(obj, '__doc__') or not obj.__doc__: + return skip + return False def setup(app): - pass + app.connect('autodoc-skip-member', member_function_test) diff --git a/doc/img/logo.png b/doc/img/logo.png index b9dd573a01019afd1af58a881996930e5212699d..b60858a7068bf45c1ed8e3da12fe244ccdcfe85d 100644 Binary files a/doc/img/logo.png and b/doc/img/logo.png differ diff --git a/setup.py b/setup.py index 1b18f4dbd3d61bef4b1fbcf7d6e09f3e540caf09..d1b4f4ca172699b9385d4edaa85fb199cd59fd46 100644 --- a/setup.py +++ b/setup.py @@ -18,8 +18,8 @@ setup( name='bob.db.atnt', version=version, description='ATNT/ORL Database Access API for Bob', - url='http://github.com/bioidiap/bob.db.atnt', - license='GPLv3', + url='http://gitlab.idiap.ch/bob/bob.db.atnt', + license='BSD', author='Manuel Guenther', author_email='manuel.guenther@idiap.ch', long_description=open('README.rst').read(), @@ -44,7 +44,7 @@ setup( 'Framework :: Bob', 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', - 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + 'License :: OSI Approved :: BSD License', 'Natural Language :: English', 'Programming Language :: Python', 'Programming Language :: Python :: 3',