Closed RHammond2 closed 1 year ago
When looking at the new documentation I noticed that example 2b is not included in the examples documentation. Should this be added, or is there a reason it isn't included yet?
It was intentional but only because it hadn't been updated with example 2, so I was unsure if it should be included or not. Happy to bring up to date and reinstate it though.
I think we should include example 2b, since it highlights the more advanced features of the AEP analysis. Let me know if there's anything I can do to help with that.
Additionally, it would be nice to have some tables or lists in the documentation showing the tag names, units, frequencies, and any other requirements, broken out by analysis type.
We could also compile a superset of all possible columns into one large schema document.
I suggest this all be defined in JSON files somewhere (such as an Analysis_Requirements JSON file, and a PlantSchema JSON file), which is then read in by Sphinx to generate the tables automatically. Related to #227
This issue is a reflection of the unaddressed content improvements from @jordanperr and @ejsimley in #207.
sphinx/index.rst
sphinx/index.rst
(@ejsimley)sphinx/examples/index.rst
sphinx/api/types.rst
needs to be rewritten to be more sensible and applicable to userssphinx/api/analysis.rst
and if we want more description in the RST file for each of the analysis categories (or methods) or just to modify the docstring content that populates these pages