Apidocs

[alejandrosantanabonilla]

new documentation

[obackhouse]

Check list before merging:

• [x] Make sure docstrings are rendering online
• [x] Move the sphinx build to the CI and remove the .rst files
• [x] Move README.rst

[obackhouse]

This can be kept open in case people want to review the online docs before merging - will need to make one last change to the CI before merging this so it pulls from master.

[maxnus]

What's the status of this? Should it be merged? How are docstrings discovered here, does it not use autodoc?

[alejandrosantanabonilla]

The status of this branch is the following. The apidocs have been produced using sphinx-apidoc, you can have a look using this link: https://boothgroup.github.io/Vayesta/vayesta.core.html#submodules

It has been merged with tutorials and now you can see tutorials + apidocs. The creation is done using Continous Integration and it has already passed all tests. We need to coordinate writing the docstrings for the needed functions and use the python convention for private functions. I can help with that.

[obackhouse]

lgtm, I'd say merge this after the checks and then open a new PR for expanding the coverage of docstrings