From ae9e61a29ff953ea4734ebe9583285a285f478b4 Mon Sep 17 00:00:00 2001 From: Flavio Tarsetti <flavio.tarsetti@idiap.ch> Date: Mon, 26 Sep 2022 15:04:19 +0200 Subject: [PATCH] [README] refactored README information with bob core packages --- README.rst | 120 ++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 91 insertions(+), 29 deletions(-) diff --git a/README.rst b/README.rst index e4197b6..58af5ea 100644 --- a/README.rst +++ b/README.rst @@ -1,44 +1,106 @@ ****************************************** -Bob's Documentation Aggregation Repository +Bob's Software Stack Documentation ****************************************** -This repository will build the documentation of all Bob packages at the same -time. -The built documentation is served at: https://www.idiap.ch/software/bob/documentation +Bob is a software stack that contains numerous repositories. +The core packages of it's system is listed here. -Adding a new package -==================== +bob.bio.base <bob/bob.bio.base/README.rst>: [docs](https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/stable/index.html)  [docs](https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/master/index.html)! [latest](https://img.shields.io/badge/docs-stable-yellow.svg) -To add a new package: +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.base/master/index.html -* Make sure the package is **public** first. Do not add private packages here. -* Make sure the package is in https://gitlab.idiap.ch/bob/bob first. -* The list of packages here should be in sync with `bob/bob`. -* Remove packages which are here but no longer are in `bob/bob`. -* Add it in ``conda/meta.yaml``, ``packages.txt``, ``doc/index.rst``, ``doc/readme_index.rst``, and ``doc/packages.rst``. -* You may repeat a package under several categories in ``doc/packages.rst``. -* If it plots something using matplotlib during its documentation generation, - make sure you add a symlink for it in the docs folder. +---------------------------------------------------------------------------------------- -Test this package (build the documentation) -=========================================== +bob.bio.face <bob/bob.bio.face/README.rst>: -To build and test this package, you can use bob.devtools. -After installing bob.devtools, run:: +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.face/master/index.html - $ bdt local docs -vv packages.txt +bob.bio.spear <bob/bob.bio.spear/README.rst>: -This will setup everything and build the documentation. +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.spear/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.spear/master/index.html -However, if you want to iterate on the documentation and keep building it, it's faster -to create a conda environment and build the docs manually:: +bob.bio.vein <bob/bob.bio.vein/README.rst>: - $ bdt local docs -vv packages.txt # run this once so it setups everything for you - $ bdt create -vv bob_docs # create a conda environment named ``bob_docs`` - $ conda activate bob_docs +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.vein/master/index.html -Then, to build the documentation, run:: +bob.bio.video <bob/bob.bio.video/README.rst>: - $ sphinx-build doc sphinx +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.video/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.bio.video/master/index.html -Pay attention to warning messages and carefully inspect the built documentation. +bob.devtools <bob/bob.devtools/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.devtools/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.devtools/master/index.html + +bob.extension <bob/bob.extension/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.extension/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.extension/master/index.html + +bob.fusion.base <bob/bob.fusion.base/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.fusion.base/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.fusion.base/master/index.html + +bob.io.base <bob/bob.io.base/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.io.base/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.io.base/master/index.html + +bob.learn.em <bob/bob.learn.em/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.learn.em/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.learn.em/master/index.html + +bob.measure <bob/bob.measure/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.measure/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.measure/master/index.html + +bob.pad.base <bob/bob.pad.base/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.base/master/index.html + +bob.pad.face <bob/bob.pad.face/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.face/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.pad.face/master/index.html + +bob.pipelines <bob/bob.pipelines/README.rst>: + +.. image:: https://img.shields.io/badge/docs-stable-yellow.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/stable/index.html +.. image:: https://img.shields.io/badge/docs-latest-orange.svg + :target: https://www.idiap.ch/software/bob/docs/bob/bob.pipelines/master/index.html \ No newline at end of file -- GitLab