bob.extension issues
https://gitlab.idiap.ch/bob/bob.extension/-/issues
2017-08-11T22:23:17Z
https://gitlab.idiap.ch/bob/bob.extension/-/issues/39
Integrate some our software policy into documentation here
2017-08-11T22:23:17Z
Amir MOHAMMADI
Integrate some our software policy into documentation here
It is here: https://gitlab.idiap.ch/biometric/software/wikis/software-policy
It is here: https://gitlab.idiap.ch/biometric/software/wikis/software-policy
May 2017 Hackathon
Guillaume HEUSCH
Guillaume HEUSCH
https://gitlab.idiap.ch/bob/bob.extension/-/issues/33
Documentation quirks
2017-08-11T22:23:18Z
André Anjos
Documentation quirks
Our documentation needs some refresh:
* [x] Code-block misalignments: https://www.idiap.ch/software/bob/docs/latest/bob/bob.extension/master/guide.html#release-methodology-for-satellite-packages
* [x] ~~Non functioning REF_: https://www...
Our documentation needs some refresh:
* [x] Code-block misalignments: https://www.idiap.ch/software/bob/docs/latest/bob/bob.extension/master/guide.html#release-methodology-for-satellite-packages
* [x] ~~Non functioning REF_: https://www.idiap.ch/software/bob/docs/latest/bob/bob.extension/master/cpp_api.html#c-api-of-the-documentation-classes~~
* [x] Needs refresh: https://www.idiap.ch/software/bob/docs/latest/bob/bob.extension/master/guide.html#change-the-version-of-your-satellite-package
* [x] Improve the development guide
May 2017 Hackathon
Guillaume HEUSCH
Guillaume HEUSCH
https://gitlab.idiap.ch/bob/bob.extension/-/issues/28
Automatic docstring generator should adopt one of "Napoleon" styles
2019-09-04T13:12:40Z
André Anjos
Automatic docstring generator should adopt one of "Napoleon" styles
When we wrote our documentation generator in [documentation.h](bob/extension/include/bob.extension/documentation.h), there was not a set standard for documenting functions in sphinx. Since release 1.3 (which is now required by most of ou...
When we wrote our documentation generator in [documentation.h](bob/extension/include/bob.extension/documentation.h), there was not a set standard for documenting functions in sphinx. Since release 1.3 (which is now required by most of our software), there is:
http://www.sphinx-doc.org/en/stable/ext/napoleon.html
The napoleon extension is already loaded by most of our software, so it makes sense that the generator follows one of the docstring standards defined on that manual page. Some of our python-based docstrings already follow the "Google" style:
http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
It would be good to get the C++ docs matching that.
May 2017 Hackathon
Pavel KORSHUNOV
Pavel KORSHUNOV