ODM2 Sphinx doc system and docstring conventions documentation

[emiliom]

I assume that this "meta" repo is just like any other, and can have issues. So, given that it's intended as a repo that provides common information across the ODM2 software ecosystem, I think this is a good place (for now anyway) to craft and eventually store documentation about the conventions and systems we've put in place for code docstrings and to generate Sphinx documentation (both automatic API docs as well as complementary Sphinx pages).

Because that system was first developed for odm2api, currently the documentation we've compiled is found as issues in that repo:

• Documentation standard? ODM2PythonAPI#97
• Docstring Conventions ODM2PythonAPI#106

Unless there are objections, I'll eventually migrate that content into a mix of issues and a markdown document on this meta repo.

[emiliom]

Note to self: add instructions on how to install and run sphinx locally, to be able to test new documentation edits. I'll copy the detailed documentation from the internal NANOOS DMAC sphinx docs.

[emiliom]

Currently implemented Sphinx docs:

• http://odm2.github.io/ODM2PythonAPI/
• http://odm2.github.io/ODM2-Admin/
• http://odm2.github.io/WOFpy/