Updates to Sphinx 3.2.x

I had to update doc/conf.py since an old flag we were using autodoc_default_flags is not supported anymore. The new one is autodoc_default_options (https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options). After activating it, we observed a few more issues related to double-documentation of attributes in some classes.

@amohammadi: there are some take-aways for Bob projects here as well.

Note that, we're testing against 3.2.1 but your branch is called sphinx 3.1.x,

For such duplication errors, you can add context to the parameter name. See docs@e93323cf

I put up this wiki https://gitlab.idiap.ch/bob/bob/-/wikis/How-to-upgrade-to-Sphinx-3 to help people with this transition. Please update it as you go along.

changed title from Updates to Sphinx 3.1.x to Updates to Sphinx 3.2.x

changed the description

@samuel.gaist: thanks, but that does not solve this one. The problem here is slightly different: there is double documentation.

I see your point now, I wasn't on the same line.

All good.

added 1 commit

• f53eeaea - [algorithm,database,dataformat,library] De-duplicated documentation of attributes

Compare with previous version

This is now green, @samuel.gaist. Once you merge it, wait for the master deployment. Then, re-trigger a beat.core pipeline to fix the issue on beat.core!128 (merged).

Notice you may have to apply similar changes to doc/conf.py as applied here to beat.core documentation, so that users of beat.core will be able to cross-reference its resources.

merged

mentioned in commit c75c4518