-
Notifications
You must be signed in to change notification settings - Fork 22
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
Split index into multiple parts and add automated document check #241
Conversation
Ref Issue #149 - this will generate .idx files that can be used to access the attributes/apis/macros/constants/structs from the standard. That will be useful when building the document checker. Keeping this a WIP for now as I work on the document checker script. |
PDF rendering of the current state of the PR (so you can see the indexing) |
I plan to discuss the indexing changes in the PMIx Standard meeting on Friday, June 11. So I won't plan to merge before then. This is missing one optional feature of (we don't need it right now so we can wait on it)
|
Very nice @jjhursey! I wonder if we can leverage this work to improve the coverage analysis and cleanup some of the inconsistencies that @rhc54 pointed out. |
Per teleconf June 12, 2020
|
* Multiple indices will make it easier to find APIs vs attributes vs ... * This is also a first step to an automatic document checker Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
* `make check-openpmix` target Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
* This allows the binding to nest under the main definition in the index Signed-off-by: Joshua Hursey <jhursey@us.ibm.com>
This version uses bold and underlining to denote the Definition in the index (instead of a separate Definition line). I moved all the indices to single column as that helped scanning down the list for a given item. I think this is ready for review for inclusion in v4. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Thanks!
Closes #149