Open
Conversation
…ry README - Add `sample_hpp` subcommand for generating Vulkan-Hpp samples with fallback to `sample_api` - Automatically update Antora nav.adoc with new sample entries, nesting HPP variants under base samples - Automatically add sample sections to category README with optional `--readme-description` flag - Improve documentation with usage examples and optional parameter syntax - Add `slugify()` helper to match CMake folder naming conventions
Contributor
asuessenbach
left a comment
There was a problem hiding this comment.
It seems evaluating variables as part of a string should be done differently:
| + "HPP template 'sample_hpp' not found, falling back to 'sample_api'. The generated sample will not be Vulkan-Hpp based unless you provide the template." | ||
| + terminal_colors.END | ||
| ) | ||
| template_to_use = "sample_api" |
Contributor
There was a problem hiding this comment.
You take "sample_api" as a fallback, but do not check for os.path.isdir?
| nav_title = title_base | ||
|
|
||
| # Find the category block header | ||
| cat_header = "* xref:samples/{category}/README.adoc" |
Contributor
There was a problem hiding this comment.
With my environment, cat_header now looks like "* xref::samples/{category}/README.adoc", which obviously is not found in the lines of nav.adoc.
What works for me is
cat_header = "* xref:samples/" + category + "/README.adoc"
And then, the entries generated in nav.adoc and README.adoc are a bit strange:
** {target_ref}[{nav_title}]
and
=== {target_ref}[{title}]
{desc}
Collaborator
|
How is this supposed to work? I don't see a hpp template file under "bldsys\cmake\template", where the other template files are placed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
sample_hppsubcommand for generating Vulkan-Hpp samples with fallback tosample_api--readme-descriptionflagslugify()helper to match CMake folder naming conventionsDescription
Please include a summary of the change, new sample or fixed issue. Please also include relevant motivation and context.
Please read the contribution guidelines
Fixes #
General Checklist:
Please ensure the following points are checked:
Note: The Samples CI runs a number of checks including:
If this PR contains framework changes:
batchcommand line argument to make sure all samples still work properlySample Checklist
If your PR contains a new or modified sample, these further checks must be carried out in addition to the General Checklist: