-
-
Notifications
You must be signed in to change notification settings - Fork 201
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
Add support for content-only flag when rendering pages #645
Add support for content-only flag when rendering pages #645
Conversation
cc @utzig |
Signed-off-by: Gerard Marull-Paretas <[email protected]>
Indicate support for the content-only option. Signed-off-by: Gerard Marull-Paretas <[email protected]>
418b974
to
10c90e0
Compare
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. One interesting change is that adding :content-only:
creates a new section with the title from the \page
element, which IMO is correct and was not done previously. Would be interesting to eventually also update non :content-only:
to also add this section.
Btw, I tested a previously fetched version from a few days ago and missed that you force pushed a change, so now it seems you made it consistent without the title; I personally liked the version that had the title extracted from the |
@utzig the reason I removed title inclusion is because in some occasions, it is helpful to include content between title and the actual content, e.g. to insert a toctree to reference doxygen |
@vermeeren can you review? thanks |
@michaeljones can you review? thanks |
@gmarull (and others) I should be able to get to all pending reviews and issues this week, some unexpected events ended up taking a significant amount of time in the past month. |
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.
@gmarull Looks good, thanks for the patches!
Support for pages was added in #596. This PR adds support for the
content-only
flag when rendering pages, so that when creating an rst file with onlythe entire page is rendered as if it was a native rst page.
Note that this is my first contribution to breathe, so expect a non-optimal/wrong solution. Suggestions are welcome :-)