diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000000000000000000000000000000000000..293eb7bc13967f6f3529d47f00468345f5470d28
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,275 @@
+# 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:
+ - BOB_PREFIX_PATH=${CONDA_FOLDER}/envs/`cat ${CONDA_FOLDER}/envs/latest-devel-${PYTHON_VER}.txt` ./bin/buildout
+ - ./bin/sphinx-build doc sphinx
+ - ./bin/python setup.py bdist_wheel
+ 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 and tests
+build_linux_27:
+ <<: *linux_build_job
+ variables: &linux_27_build_variables
+ <<: *linux_build_variables
+ PYTHON_VER: "2.7"
+ 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"
+ tags:
+ - conda-linux
+
+test_linux_34:
+ <<: *test_job
+ variables: *linux_34_build_variables
+ dependencies:
+ - build_linux_34
+ tags:
+ - conda-linux
+
+wheels_linux_34:
+ <<: *wheels_job
+ dependencies:
+ - build_linux_34
+ tags:
+ - conda-linux
+
+
+# Linux + Python 3.5: Builds and tests
+build_linux_35:
+ <<: *linux_build_job
+ variables: &linux_35_build_variables
+ <<: *linux_build_variables
+ PYTHON_VER: "3.5"
+ 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, tests and uploads the wheel
+build_macosx_27:
+ <<: *macosx_build_job
+ variables: &macosx_27_build_variables
+ <<: *macosx_build_variables
+ PYTHON_VER: "2.7"
+ tags:
+ - conda-macosx
+
+test_macosx_27:
+ <<: *test_job
+ variables: *macosx_27_build_variables
+ dependencies:
+ - build_macosx_27
+ tags:
+ - conda-macosx
+
+wheels_macosx_27:
+ <<: *wheels_job
+ 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"
+ tags:
+ - conda-macosx
+
+test_macosx_34:
+ <<: *test_job
+ variables: *macosx_34_build_variables
+ dependencies:
+ - build_macosx_34
+ tags:
+ - conda-macosx
+
+wheels_macosx_34:
+ <<: *wheels_job
+ dependencies:
+ - build_macosx_34
+ tags:
+ - conda-macosx
+
+
+# Mac OSX + Python 3.5: Builds, tests, uploads the wheel and the latest docs
+build_macosx_35:
+ <<: *macosx_build_job
+ variables: &macosx_35_build_variables
+ <<: *macosx_build_variables
+ PYTHON_VER: "3.5"
+ tags:
+ - conda-macosx
+
+test_macosx_35:
+ <<: *test_job
+ variables: *macosx_35_build_variables
+ dependencies:
+ - build_macosx_35
+ tags:
+ - conda-macosx
+
+wheels_macosx_35:
+ <<: *wheels_job
+ 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 9e480d6e67bc09556195afdd5bb87df90c1629e3..0000000000000000000000000000000000000000
--- a/.travis.yml
+++ /dev/null
@@ -1,37 +0,0 @@
-language: python
-env:
- global:
- - secure: QSqodxRXJWkKhD1IKFNe1fx/ICpTVlsxgg44FRugrUnInYeWPzmQhQKnmhnCVwlRzYvrCbA5tyC2pZFML4hNBQYgN3gYJxxJR3fpJ9ZSb4xVUD/3LW5iMUzDloEA0/SyT2++W6NAUy85VwjbVeAg4yWBbCeCfFWb6LQUPENO/I8=
- - secure: E1oP5OQ9+keu/GdxV7ju3FZgQBXBvVp0EIq1ge5spsb4ZbZmrcTCzb2hawSo0AHv/ECVYBnM3KcA2TPu6ZcYN0u1oAHM0nojSDllOc7/s1IhRxI/c7RZGTWAhfCklgpAOhdxq6DKIYoJUlq/gLiGIXYGa9jTF27uyEGAm3vnLv0=
- - BOB_UPLOAD_WHEEL=1
-matrix:
- include:
- - python: 2.7
- env:
- - BOB_DOCUMENTATION_SERVER=https://www.idiap.ch/software/bob/docs/latest/bioidiap/%s/master
- - 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 libatlas-dev libatlas-base-dev liblapack-dev libhdf5-serial-dev libvl-dev texlive-latex-base texlive-latex-extra texlive-math-extra texlive-latex-recommended texlive-fonts-recommended
-- sudo apt-get install -qq --force-yes libjpeg8-dev libnetpbm10-dev libpng12-dev libtiff4-dev libgif-dev
-- pip install --upgrade pip
-- pip install --find-links https://www.idiap.ch/software/bob/wheels/travis/ --use-wheel sphinx nose numpy matplotlib coverage cpp-coveralls
-- pip install --find-links https://www.idiap.ch/software/bob/wheels/travis/ --use-wheel --pre -r requirements.txt coveralls
-install:
-- python bootstrap-buildout.py
-- CPPFLAGS=--coverage LDFLAGS=--coverage ./bin/buildout buildout:debug=false buildout:develop=. buildout:extensions=bob.buildout buildout:auto-checkout=
-script:
-- ./bin/python -c 'import pkg_resources; from bob.ip.flandmark import get_config; print(get_config())'
-- ./bin/coverage run --source=bob.ip.flandmark ./bin/nosetests -sv
-- ./bin/sphinx-build -b doctest doc sphinx
-- ./bin/sphinx-build -b html doc sphinx
-after_success:
-- cpp-coveralls --build-root=`pwd` --exclude=src --exclude-pattern=".*Compiler.*" --dump=cpp_cov.json
-- coveralls --merge=cpp_cov.json
-- 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
index 7ac8998a23ffd779d3e33b4fa0bc6c1301353c81..bd46ce15068f2d3b5a1b23ac6c68a33ec808d95d 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,16 +1,19 @@
-Copyright (c) 2013, Andre Anjos - Idiap Research Institute
-All rights reserved.
+Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/
+Written by Andre Anjos <andre.anjos@idiap.ch>
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
-Redistributions of source code must retain the above copyright notice, this
-list of conditions and the following disclaimer. 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. Neither the name of the Idiap Research Institute nor the
-names of its contributors may be used to endorse or promote products derived
-from this software without specific prior written permission.
+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
@@ -21,4 +24,4 @@ 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.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/MANIFEST.in b/MANIFEST.in
index c856a9baccf06bd1fd2aebebc13138bfe14468f9..64df6d0d3fd4257310e9cf67ef30d16c723db3b4 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,3 @@
-include LICENSE README.rst bootstrap-buildout.py buildout.cfg requirements.txt version.txt
+include LICENSE README.rst bootstrap-buildout.py buildout.cfg develop.cfg requirements.txt version.txt
recursive-include doc *.rst *.py
recursive-include bob *.cpp *.h *.dat *.jpg
diff --git a/README.rst b/README.rst
index 40088ad1d3fe429ef18c12c28270af514d56521b..8327e0cf5c9c73e7f31e8271ecddee04160f2902 100644
--- a/README.rst
+++ b/README.rst
@@ -1,28 +1,29 @@
.. vim: set fileencoding=utf-8 :
-.. Andre Anjos <andre.anjos@idiap.ch>
-.. Thu 17 Apr 16:59:12 2014 CEST
+.. Mon 15 Aug 2016 18:52:57 CEST
.. image:: http://img.shields.io/badge/docs-stable-yellow.png
:target: http://pythonhosted.org/bob.ip.flandmark/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
:target: https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.ip.flandmark/master/index.html
-.. image:: https://travis-ci.org/bioidiap/bob.ip.flandmark.svg?branch=master
- :target: https://travis-ci.org/bioidiap/bob.ip.flandmark
-.. image:: https://coveralls.io/repos/bioidiap/bob.ip.flandmark/badge.svg?branch=master
- :target: https://coveralls.io/r/bioidiap/bob.ip.flandmark
-.. image:: https://img.shields.io/badge/github-master-0000c0.png
- :target: https://github.com/bioidiap/bob.ip.flandmark/tree/master
+.. image:: https://gitlab.idiap.ch/bob/bob.ip.flandmark/badges/master/build.svg
+ :target: https://gitlab.idiap.ch/bob/bob.ip.flandmark/commits/master
+.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
+ :target: https://gitlab.idiap.ch/bob/bob.ip.flandmark
.. image:: http://img.shields.io/pypi/v/bob.ip.flandmark.png
:target: https://pypi.python.org/pypi/bob.ip.flandmark
.. image:: http://img.shields.io/pypi/dm/bob.ip.flandmark.png
:target: https://pypi.python.org/pypi/bob.ip.flandmark
-==============================
- Python Bindings to Flandmark
-==============================
-This package is a simple Python wrapper to the (rather quick) open-source facial landmark detector Flandmark_, **version 1.0.7** (or the github state as of 10/february/2013).
-If you use this package, the author asks you to cite the following paper::
+=========================================
+ Flandmark keypoint localization library
+=========================================
+
+This package is part of the signal-processing and machine learning toolbox
+Bob_. It contains a simple Python wrapper to the (rather quick) open-source
+facial landmark detector Flandmark_, **version 1.0.7** (or the github state as
+of 10/february/2013). If you use this package, the author asks you to cite the
+following paper::
@inproceedings{Uricar-Franc-Hlavac-VISAPP-2012,
author = {U\v{r}i\v{c}\'a\v{r}, Michal and Franc, Vojt\v{e}ch and Hlav\'a\v{c}, V\'{a}clav},
@@ -47,29 +48,26 @@ If you use this package, the author asks you to cite the following paper::
www = {http://www.visapp.visigrapp.org},
}
-You should also cite `Bob`_, as a core framework, in which these bindings are based on::
-
- @inproceedings{Anjos_ACMMM_2012,
- author = {Anjos, Andr\'e AND El Shafey, Laurent AND Wallace, Roy AND G\"unther, Manuel AND McCool, Christopher AND Marcel, S\'ebastien},
- title = {Bob: a free signal processing and machine learning toolbox for researchers},
- year = {2012},
- month = oct,
- booktitle = {20th ACM Conference on Multimedia Systems (ACMMM), Nara, Japan},
- publisher = {ACM Press},
- url = {http://publications.idiap.ch/downloads/papers/2012/Anjos_Bob_ACMMM12.pdf},
- }
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.ip.flandmark/index.html>`_ or the `Latest Version <https://www.idiap.ch/software/bob/docs/latest/bioidiap/bob.ip.flandmark/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
+
+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
.. _flandmark: http://cmp.felk.cvut.cz/~uricamic/flandmark/index.php
-
diff --git a/bootstrap-buildout.py b/bootstrap-buildout.py
index 1f59b213790bcb32f3fd9fe1da819730253642e2..a4599211f741c468cd37a29861d1c7f2c3a641d1 100644
--- a/bootstrap-buildout.py
+++ b/bootstrap-buildout.py
@@ -49,8 +49,8 @@ parser.add_option("--version",
parser.add_option("-t", "--accept-buildout-test-releases",
dest='accept_buildout_test_releases',
action="store_true", default=False,
- help=("Normally, if you do not specify a --buildout-version, "
- "the bootstrap script and buildout gets the newest "
+ help=("Normally, if you do not specify a --version, the "
+ "bootstrap script and buildout gets the newest "
"*final* versions of zc.buildout and its recipes and "
"extensions for you. If you use this flag, "
"bootstrap and buildout will get the newest releases "
diff --git a/buildout.cfg b/buildout.cfg
index 22feea45b3e55592c09fcbda9bcdf30388989ed2..939c286593d93d46e496f2f94fffd0c61abaa511 100644
--- a/buildout.cfg
+++ b/buildout.cfg
@@ -1,43 +1,13 @@
; vim: set fileencoding=utf-8 :
-; Andre Anjos <andre.anjos@idiap.ch>
-; Thu 17 Apr 15:06:39 2014 CEST
+; Mon 15 Aug 2016 18:52:57 CEST
[buildout]
parts = scripts
+develop = .
eggs = bob.ip.flandmark
- bob.extension
extensions = bob.buildout
- mr.developer
-auto-checkout = *
-develop = src/bob.extension
- src/bob.blitz
- src/bob.core
- src/bob.io.base
- src/bob.io.image
- src/bob.math
- src/bob.sp
- src/bob.ip.base
- src/bob.ip.color
- src/bob.ip.draw
- .
-
-; 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.math = git https://github.com/bioidiap/bob.math
-bob.sp = git https://github.com/bioidiap/bob.sp
-bob.ip.base = git https://github.com/bioidiap/bob.ip.base
-; For test and documentation generation only:
-bob.io.image = git https://github.com/bioidiap/bob.io.image
-bob.ip.color = git https://github.com/bioidiap/bob.ip.color
-bob.ip.draw = git https://github.com/bioidiap/bob.ip.draw
+verbose = true
[scripts]
-recipe = bob.buildout:scripts
+recipe = bob.buildout:scripts
\ No newline at end of file
diff --git a/develop.cfg b/develop.cfg
new file mode 100644
index 0000000000000000000000000000000000000000..aa8f48a16b877f39c06a448f88ec8c88bda3ee1b
--- /dev/null
+++ b/develop.cfg
@@ -0,0 +1,43 @@
+; vim: set fileencoding=utf-8 :
+; Andre Anjos <andre.anjos@idiap.ch>
+; Thu 17 Apr 15:06:39 2014 CEST
+
+[buildout]
+parts = scripts
+eggs = bob.ip.flandmark
+ bob.extension
+extensions = bob.buildout
+ mr.developer
+auto-checkout = *
+develop = src/bob.extension
+ src/bob.blitz
+ src/bob.core
+ src/bob.io.base
+ src/bob.io.image
+ src/bob.math
+ src/bob.sp
+ src/bob.ip.base
+ src/bob.ip.color
+ src/bob.ip.draw
+ .
+
+; 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.math = git https://gitlab.idiap.ch/bob/bob.math
+bob.sp = git https://gitlab.idiap.ch/bob/bob.sp
+bob.ip.base = git https://gitlab.idiap.ch/bob/bob.ip.base
+; For test and documentation generation only:
+bob.io.image = git https://gitlab.idiap.ch/bob/bob.io.image
+bob.ip.color = git https://gitlab.idiap.ch/bob/bob.ip.color
+bob.ip.draw = git https://gitlab.idiap.ch/bob/bob.ip.draw
+
+[scripts]
+recipe = bob.buildout:scripts
diff --git a/doc/conf.py b/doc/conf.py
index 8f0535070dd06279db9bf68096bd2b15b9e402df..f393974609f0bb7153179f723779faa74445affd 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,47 +1,47 @@
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
-# Andre Anjos <andre.anjos@idiap.ch>
-# Tue 15 Oct 16:37:18 2013 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'
+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.intersphinx',
- 'sphinx.ext.doctest',
- 'matplotlib.sphinxext.plot_directive',
- ]
+ '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
@@ -64,7 +64,7 @@ import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
# Grab the setup entry
-distribution = pkg_resources.require('bob.ip.flandmark')[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
@@ -109,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'Flandmark keypoint localization library'
+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
@@ -123,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_ip_flandmark'
+#html_short_title = project_variable
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@ -188,72 +193,48 @@ html_favicon = 'img/favicon.ico'
#html_file_suffix = None
# Output file base name for HTML help builder.
-htmlhelp_basename = 'bob_ip_flandmark_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_ip_flandmark.tex', u'Python bindings to the Flandmark frontal-face keypoint localizer', 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 = """
.. |project| replace:: Bob
-.. |url| replace:: https://www.idiap.ch/software/bob/
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)
-# -- 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_ip_flandmark', u'Python bindings to Flandmark frontal-face keypoint localizer', [u'Idiap Research Institute'], 1)
-]
-
-
# 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()
+# 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 9dbb352e4565af3ff01764f98d7296744422382f..b6da1b7c90206a48aa2bfaf5a704eb5cb5c4db2c 100644
--- a/setup.py
+++ b/setup.py
@@ -25,12 +25,12 @@ setup(
name="bob.ip.flandmark",
version=version,
- description="Python bindings to the flandmark keypoint localization library",
- license="GPLv3",
+ description="Flandmark keypoint localization library",
+ license="BSD",
author='Andre Anjos',
author_email='andre.anjos@idiap.ch',
long_description=open('README.rst').read(),
- url='https://github.com/bioidiap/bob.ip.flandmark',
+ url='https://gitlab.idiap.ch/bob/bob.ip.flandmark',
packages=find_packages(),
include_package_data=True,