-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Why aren't Condition and ConditionSet being generated in our documentation? #292
Comments
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 |
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 |
The above is a workaround, but needs cleaner / standard implementation |
|
The remaining issue is that the docs for ConditionSet etc. should be automatically generated from the first line here: Lines 44 to 56 in c61fc54
so |
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...
The text was updated successfully, but these errors were encountered: