Merge branch 'patch-doc' into 'master'

Point to gitlab pages, remove conda installations instructions



See merge request !45

doc/implementation.rst

@@ -218,7 +218,7 @@ Verification Database Interface
 
 For most of the data sets, we rely on the database interfaces from Bob_.
 
-Particularly, all databases that are derived from the :py:class:`bob.bio.base.database.BioDatabase` (click `here <https://github.com/idiap/bob/wiki/Packages>`_ for a list of implemented databases) are supported by a special derivation of the databases from above.
+Particularly, all databases that are derived from the :py:class:`bob.bio.base.database.BioDatabase` (click `here <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_ for a list of implemented databases) are supported by a special derivation of the databases from above.
 For these databases, the special :py:class:`bob.bio.base.database.BioDatabase` interface is provided, which takes the Bob_ database as parameter.
 Several such databases are defined in the according packages, i.e., :ref:`bob.bio.spear <bob.bio.spear>`, :ref:`bob.bio.face <bob.bio.face>` and :ref:`bob.bio.video <bob.bio.video>`.
 For Bob_'s ZT-norm databases, we provide the :py:class:`bob.bio.base.database.ZTBioDatabase` interface.
@@ -325,7 +325,7 @@ Particularly, we use a specific list of entry points, which are:
 For each of the tools, several resources are defined, which you can list with the ``./bin/resources.py`` command line.
 
 When you want to register your own resource, make sure that your configuration file is importable (usually it is sufficient to have an empty ``__init__.py`` file in the same directory as your configuration file).
-Then, you can simply add a line inside the according ``entry_points`` section of the ``setup.py`` file (you might need to create that section, just follow the example of the ``setup.py`` file that you can find online in the base directory of our `bob.bio.base GitHub page <http://github.com/bioidiap/bob.bio.base>`__).
+Then, you can simply add a line inside the according ``entry_points`` section of the ``setup.py`` file (you might need to create that section, just follow the example of the ``setup.py`` file that you can find online in the base directory of our `bob.bio.base Gitlab page <http://gitlab.idiap.ch/bob/bob.bio.base>`__).
 
 After re-running ``./bin/buildout``, your new resource should be listed in the output of ``./bin/resources.py``.
 

doc/installation.rst

@@ -9,32 +9,31 @@ Installation Instructions
 =========================
 
 As noted before, this package is part of the ``bob.bio`` packages, which in turn are part of the signal-processing and machine learning toolbox Bob_.
-To install `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_, please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_.
+To install `Packages of Bob <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_, please read the `Installation Instructions <https://gitlab.idiap.ch/bob/bob/wikis/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.
+Please make sure that you have read the `Dependencies <https://gitlab.idiap.ch/bob/bob/wikis/Dependencies>`_ for your operating system.
 
 .. note::
   Currently, running Bob_ under MS Windows in not yet supported.
   However, we found that running Bob_ in a virtual Unix environment such as the one provided by VirtualBox_ is a good alternative.
 
-Installation via conda
+Installation via pip
 ----------------------
 
-The most simple and most convenient way to use the ``bob.bio`` tools is to install it using `conda <http://conda.pydata.org/docs/intro.html>`_.
-We offer pre-compiled binary installations of Bob_ and ``bob.bio`` with conda.
-After setting up your conda environment (you can find the instructions `here <https://gitlab.idiap.ch/bob/bob/wikis/Installation>`_), use the sequence of commands to
-first search the ``bob.bio`` in the conda-forge channel and then install it.
+The most simple and most convenient way to use the ``bob.bio`` tools is to install it using `pip`.
+After setting up your python environment (you can find the instructions `here <https://gitlab.idiap.ch/bob/bob/wikis/Installation>`_), use the sequence of commands to
+first search the ``bob.bio`` packages and then install it.
 
 .. code-block:: sh
 
-   $ conda search bob.bio # searching
-   $ conda install bob.bio.base # Install the base package
+   $ pip search bob.bio # searching
+   $ pip install bob.bio.base # Install the base package
 
 
 Installation via zc.buildout
 ----------------------------
 
-Another convenient way to use the ``bob.bio`` tools is to use a ``zc.buildout`` package, as explained in more detail `here <https://github.com/idiap/bob/wiki/Installation#using-zcbuildout-for-production>`__.
+Another convenient way to use the ``bob.bio`` tools is to use a ``zc.buildout`` package, as explained in more detail `here <https://gitlab.idiap.ch/bob/bob/wikis/Installation#using-zcbuildout-for-production>`__.
 There, in the ``eggs`` section of the ``buildout.cfg`` file, simply list the ``bob.bio`` packages that you want, like:
 
 .. code-block:: python
@@ -64,7 +63,7 @@ Databases
 With ``bob.bio`` you will run biometric recognition experiments using some default biometric recognition databases.
 Though the verification protocols are implemented in ``bob.bio``, the original data are **not included**.
 To download the original data of the databases, please refer to the according Web-pages.
-For a list of supported databases including their download URLs, please refer to the `verification_databases <https://github.com/idiap/bob/wiki/Packages>`_.
+For a list of supported databases including their download URLs, please refer to the `verification_databases <https://gitlab.idiap.ch/bob/bob/wikis/Packages>`_.
 
 After downloading the original data for the databases, you will need to tell ``bob.bio``, where these databases can be found.
 For this purpose, we have decided to implement a special file, where you can set your directories.
@@ -114,7 +113,7 @@ To avoid the download to happen each time you call the nose tests, please:
   To set the directory permanently, you can also change the ``atnt_default_directory`` in the file `bob/bio/base/test/utils.py <file:../bob/bio/base/test/utils.py>`_.
   In this case, there is no need to set the environment variable any more.
 
-In case any of the tests fail for unexplainable reasons, please file a bug report through the `GitHub bug reporting system`_.
+In case any of the tests fail for unexplainable reasons, please send a report through our `mailing list`_.
 
 .. note::
   Usually, all tests should pass with the latest stable versions of the Bob_ packages.

doc/links.rst

@@ -5,13 +5,10 @@
 .. This file contains all links we use for documentation in a centralized place
 
 .. _idiap: http://www.idiap.ch
-.. _github: http://www.github.com/idiap
 .. _bob: http://www.idiap.ch/software/bob
-.. _github bug reporting system: http://github.com/bioidiap/bob.bio.base/issues
-.. _idiap at github: http://www.github.com/bioidiap
+.. _idiap at gitlab: http://gitlab.idiap.ch/bob
 .. _at&t database: http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html
-.. _bob's github page: http://idiap.github.com/bob
-.. _gridtk: http://github.com/idiap/gridtk
+.. _gridtk: http://gitlab.idiap.ch/bob/gridtk
 .. _buildout: http://www.buildout.org
 .. _setuptools: http://trac.edgewall.org/wiki/setuptools
 .. _nist: http://www.nist.gov/itl/iad/ig/focs.cfm
@@ -21,3 +18,4 @@
 .. _xfacereclib.extension.csu: http://pypi.python.org/pypi/xfacereclib.extension.CSU
 .. _virtualbox: https://www.virtualbox.org
 .. _hdf5: http://www.hdfgroup.org/HDF5
+.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel

setup.py

@@ -18,7 +18,7 @@ setup(
     version = open("version.txt").read().rstrip(),
     description = 'Tools for running biometric recognition experiments',
 
-    url = 'https://www.gitlab.idiap.ch/bob/bob.bio.base',
+    url = 'https://gitlab.idiap.ch/bob/bob.bio.base',
     license = 'BSD',
     author = 'Manuel Gunther',
     author_email = 'siebenkopf@googlemail.com',
@@ -49,7 +49,7 @@ setup(
     #
     # Our database packages are good examples of namespace implementations
     # using several layers. You can check them out here:
-    # https://github.com/idiap/bob/wiki/Satellite-Packages
+    # https://gitlab.idiap.ch/bob/bob/wikis/Packages
 
 
     # This entry defines which scripts you will have inside the 'bin' directory