Switch to a common documentation

[anilbey]

Make sure the return values, parameters and the exceptions thrown are mentioned for each method.

[anilbey]

Perhaps doxygen
https://www.jetbrains.com/help/clion/creating-and-viewing-doxygen-documentation.html

[anilbey]

Or Doxygen + Sphinx + Breathe
https://www.reddit.com/r/cpp/comments/6r1z2p/2017_what_is_your_favourite_cpp_documentation/
https://breathe.readthedocs.io/en/latest/

[anilbey]

Have docs passing / docs failing badge afterwards

[anilbey]

Or use Exhale which is Doxygen + Sphinx + Breathe
https://github.com/svenevs/exhale
https://exhale.readthedocs.io/en/latest/index.html

[pedrofale]

@anilbey would you like to do this? Using Sphinx we could also provide the notebook examples in the docs, which would keep them updated with every code version (#102).

[anilbey]

Sorry for the late reply. I'll look into it.