Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add TextRender usage documentation #84

Merged
merged 4 commits into from
May 8, 2015
Merged

Add TextRender usage documentation #84

merged 4 commits into from
May 8, 2015

Conversation

stdweird
Copy link
Member

This is the CAF::TextRender part of the tutorial given during the 19th workshop.

@stdweird stdweird added this to the 15.4 milestone Mar 26, 2015
@stdweird stdweird self-assigned this Mar 26, 2015
@hpcugentbot
Copy link

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/CAF-pr-builder/202/
Test PASSed.

jrha
jrha reviewed Apr 28, 2015
View reviewed changes
TextRender.md
Generating structured text is best done with [`CAF::TextRender`][caf_textrender_docs].
This document guides through the usage and testing of `CAF::TextRender`.

Using `ncm-metaconfig`, which is the metacomponent build around
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

built

@jouvin
Copy link
Contributor

jouvin commented May 4, 2015

It would be good to have it finalized at the time of 15.4, even if not strictly part of the release...

@stdweird stdweird mentioned this pull request May 5, 2015
Merged
@hpcugentbot
Copy link

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/CAF-pr-builder/212/
Test PASSed.

@stdweird
Copy link
Member Author

stdweird commented May 8, 2015

@jrha i'm adding a CCM::TextRender section too

@hpcugentbot
Copy link

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/CAF-pr-builder/213/
Test PASSed.

@stdweird
Copy link
Member Author

stdweird commented May 8, 2015

@jrha i added the CCM::TextRender section, including an example that will only work if some of my branches get merged in 15.6 (in particular the path magic) (but are the best example of what CCM::TextRender can do)

@hpcugentbot
Copy link

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/CAF-pr-builder/214/
Test PASSed.

@stdweird
Copy link
Member Author

stdweird commented May 8, 2015

@jrha AFAIK, readthedocs does not understand gh tags (but I removed the tags to be consistent with the rest of the doc. i opened quattor/release#86 to find a solution

@jrha
Copy link
Member

jrha commented May 8, 2015

😿

jrha added a commit that referenced this pull request May 8, 2015
@jrha
Merge pull request #84 from stdweird/getting_started_textrender
a4d56e9 
Add TextRender usage documentation
@jrha jrha merged commit a4d56e9 into quattor:master May 8, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@stdweird stdweird

Labels
None yet
Milestone
15.4
Development

Successfully merging this pull request may close these issues.
4 participants
@stdweird @hpcugentbot @jouvin @jrha