MDF icon indicating copy to clipboard operation
MDF copied to clipboard

Why aren't Condition and ConditionSet being generated in our documentation?

Open pgleeson opened this issue 3 years ago • 5 comments

Both missing from https://mdf.readthedocs.io/en/latest/api/Specification.html.

That page is generated from https://github.com/ModECI/MDF/blob/main/docs/README.md, which is a markdown export of https://github.com/ModECI/MDF/blob/main/src/modeci_mdf/mdf.py, which has classes Condition and ConditionSet...

pgleeson avatar Jul 22 '22 15:07 pgleeson

The condition and the conditionset are not being generated in the documentation because it is not documented in the readme file, even though it is addressed in the mdf.py directory, It is the readme.md file that is being fed into the readthedocs documentation so it is only issues that are addressed in the readme.md that will be mirrored in the readthedocs documentation

Monsurat-Onabajo avatar Feb 03 '23 19:02 Monsurat-Onabajo

The Specification.html page is generated from https://github.com/ModECI/MDF/blob/main/docs/sphinx/source/api/Specification.rst not the markdown file as i stated earlier

Monsurat-Onabajo avatar Feb 06 '23 22:02 Monsurat-Onabajo

The above is a workaround, but needs cleaner / standard implementation

jdcpni avatar Apr 19 '23 17:04 jdcpni

The above is a workaround, but needs cleaner / standard implementation This has been solved here: https://github.com/ModECI/MDF/actions/runs/4126125824

Monsurat-Onabajo avatar Apr 19 '23 23:04 Monsurat-Onabajo

The remaining issue is that the docs for ConditionSet etc. should be automatically generated from the first line here:

https://github.com/ModECI/MDF/blob/c61fc54eb045d68238418cf5fbc18196512e136a/docs/generate.py#L44-L56

so doc_md_1 shouldn't be required. The way the markdown is generated from mod doesn't "connect" all the way down to ConditionSet as it should (and as it does for Node, Edge etc.)

pgleeson avatar Apr 20 '23 15:04 pgleeson