README.rst 3.35 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
.. vim: set fileencoding=utf-8 :

.. Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/          ..
.. Contact: beat.support@idiap.ch                                             ..
..                                                                            ..
.. This file is part of the docs module of the BEAT platform.                 ..
..                                                                            ..
.. Commercial License Usage                                                   ..
.. Licensees holding valid commercial BEAT licenses may use this file in      ..
.. accordance with the terms contained in a written agreement between you     ..
.. and Idiap. For further information contact tto@idiap.ch                    ..
..                                                                            ..
.. Alternatively, this file may be used under the terms of the GNU Affero     ..
.. Public License version 3 as published by the Free Software and appearing   ..
.. in the file LICENSE.AGPL included in the packaging of this file.           ..
.. The BEAT platform is distributed in the hope that it will be useful, but   ..
.. WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY ..
.. or FITNESS FOR A PARTICULAR PURPOSE.                                       ..
..                                                                            ..
.. You should have received a copy of the GNU Affero Public License along     ..
.. with the BEAT platform. If not, see http://www.gnu.org/licenses/.          ..

23 24
.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
   :target: https://www.idiap.ch/software/beat/docs/beat/docs/stable/index.html
25 26
.. image:: https://img.shields.io/badge/docs-latest-orange.svg
   :target: https://www.idiap.ch/software/beat/docs/beat/docs/master/index.html
27 28 29 30
.. image:: https://gitlab.idiap.ch/beat/docs/badges/master/build.svg
   :target: https://gitlab.idiap.ch/beat/docs/commits/master
.. image:: https://gitlab.idiap.ch/beat/docs/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/beat/docs/commits/master
31 32 33
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/beat/docs

André Anjos's avatar
André Anjos committed
34 35 36 37

*******************************************
 BEAT Documentation Aggregation Repository
*******************************************
38 39 40

This repository will build the documentation of all BEAT packages at the same
time.
Flavio TARSETTI's avatar
Flavio TARSETTI committed
41

André Anjos's avatar
André Anjos committed
42

Flavio TARSETTI's avatar
Flavio TARSETTI committed
43 44 45 46 47 48 49 50 51 52 53 54 55
Adding a new package
====================

To add a new package:

* Make sure the package is **public** first. Do not add private packages here.
* Add it in ``conda/meta.yaml`` and ``requirements.txt``.
* Add it in ``doc/index.rst`` (you need to add it in several places in this file).
* Add it in ``doc/readme_index.rst``.
* Add it in ``.gitignore``.
* If it plots something using matplotlib during its documentation generation,
  make sure you add a symlink for it in the docs folder.

André Anjos's avatar
André Anjos committed
56

Flavio TARSETTI's avatar
Flavio TARSETTI committed
57 58 59 60 61 62 63 64 65 66 67 68 69
Test this package (build the documentation)
===========================================

The steps to test this package is the following you need to run the script
`before_build.sh` before testing. Checkout bob.admin in
an upper folder and make sure its repository is up-to-date. Then, run::

    $ ./before_build.sh
    $ conda activate base
    $ ../bob.admin/conda/conda-build.sh --python=3 conda

See https://gitlab.idiap.ch/bob/bob/wikis/Save-the-CI-time for up-to-date
instructions.