-
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
Adding examples #276
Adding examples #276
Conversation
Attached is a rendering of the Examples chapter from this PR: There is still some cleanup to do, and I need to add some source code compile/link checking. So still a work in progress. |
To do list:
Second Effort to do list:
|
I've pushed an update to this PR that includes a preprocessor script for the examples (see latest commit). The goal here is to add comments to an example, then the preprocessor will split out the code snippets so we can include them in the latex. See The The direct minted way still works fine, but this preprocessor script should give some more flexibility. |
Ok this is ready for review now. See the I should probably include a PMIx Python example - I can see if I can find one. |
I just pushed a commit that adds a proper PMIx python example. Should be good now for review. |
For discussion today:
|
Signed-off-by: Joshua Hursey <[email protected]>
* Uses the `minted` package to include formatted source code segments * Uses a preprocessor script to extract snippets from code examples Signed-off-by: Joshua Hursey <[email protected]>
Per discussion on the Nov. 12, 2020 ASC meeting, we decided to merge this in so the working groups can use it in their work. @SteVwonder Can you give this a 👍 review so I can merge? |
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.
LGTM! Thanks @jjhursey! The docker build also worked flawlessly!
minted
package to include formatted source code segments.