eclipse-volttron / volttron-openadr-ven

Apache License 2.0
5 stars 5 forks source link

Add RPC method for reporting; modify tests; add PNNL branding #29

Closed bonicim closed 2 years ago

bonicim commented 2 years ago

UPDATE:

~* Tested docs on html; screenshot attached:~

craig8 commented 2 years ago

It might be worth looking into this for adding typehints with docs so we don't have to document in both locations. Let me know if this is something I should help with or not? @bonicim https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints

bonicim commented 2 years ago

Will add sphinx and run it locally to test.

bonicim commented 2 years ago

It might be worth looking into this for adding typehints with docs so we don't have to document in both locations. Let me know if this is something I should help with or not? @bonicim https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints

I just saw this comment after I made the latest push, which added Sphinx and the docs/ dir. I tested the docs using make html and included a screenshot. Let me know what you think.

bonicim commented 2 years ago

Added autodoc_typehints to the documentation. Screenshot of current docs shown below. Note how custom datatypes are given the full path in the red box marker:

Screen Shot 2022-01-26 at 9 35 51 AM

craig8 commented 2 years ago

Would you add the rtd theme to the docs. The main volttron requirements for rtd are here. https://github.com/VOLTTRON/volttron/blob/main/docs/requirements.txt