Please make the bob.examples uptodate

• should go through migration guide
• update to new doc style both in Python and cpp
• explain how to write documentation properly with examples and guides

mentioned in issue bob.bio.base#36 (closed)

Reassigned to @amohammadi

From the examples, only bob.example.project is actually mentioned in the documentation. We should make sure that one is OK and conforms.

Documentation for all of the steps above is already there: https://www.idiap.ch/software/bob/docs/latest/bob/bob.extension/master/guide.html

These docs are checked and compiled every day (nightlies) and on changes.

The manual though needs an update. I see there are outdated sections.

@amohammadi: Please integrate in this section: https://www.idiap.ch/software/bob/docs/latest/bob/bob.extension/master/guide.html#using-buildout, whatever you put on https://gitlab.idiap.ch/bob/bob/wikis/buildout, then please, make https://gitlab.idiap.ch/bob/bob/wikis/Installation point to the latest bob.extension documentation instead of a wiki.

I'll wait for you to do that before reviewing the whole documentation once again.

@andre.anjos I have done what you asked here. Do you mind looking at the documentation of bob.extension again to see if things are working as expected?

https://gitlab.idiap.ch/bob/bob/wikis/Installation still points to the wiki.

Why do you want to have the installation instructions in the bob.extension docs? They change quite often and it is easier to keep them in the wiki. Shouldn't it be in bob's docs at least rather than in bob.extension?

Look at the last link on that page...

After that, I think you can close this ticket. I'll open another one for smaller issues.

marked the task should go through migration guide as completed

marked the task update to new doc style both in Python and cpp as completed

marked the task explain how to write documentation properly with examples and guides as completed

marked the task clean-up as completed

marked the task clean-up as incomplete

ok fixed the link. but maybe moving the installation instructions into bob's documentation is not a bad idea. Since old versions of bob would have old installation instructions still in them. This might help people install older versions more easily for reproducibly purposes.

assigned to @andre.anjos

Let's make this another issue and close this one. Thanks for this work.

closed