fix book example generation and inclusion #305
Merged
Conversation
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
Signed-off-by: Andrei Gherghescu <8067229+andrei-ng@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Fixes generation of inline HTML examples and updates documentation to include these new files.
- Added inline HTML export in
write_example_to_htmlfor custom, basic, and 3D charts - Updated book recipes to reference
output/inline_<name>.htmlinstead of legacyout/*.html - Retained standalone HTML output to preserve existing workflows
Reviewed Changes
Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/custom_controls/src/main.rs | Write inline HTML files before standalone HTML output |
| examples/basic_charts/src/main.rs | Write inline HTML files before standalone HTML output |
| examples/3d_charts/src/main.rs | Write inline HTML files before standalone HTML output |
| docs/book/src/recipes/.md | Updated #include paths to use output/inline_*.html |
| docs/book/src/fundamentals/shapes.md | Updated #include paths to use output/inline_*.html |
Comments suppressed due to low confidence (3)
examples/custom_controls/src/main.rs:124
- This shadows the earlier
pathvariable; consider using a distinct name likeinline_pathto improve clarity.
let path = format!("./output/inline_{}.html", name);
examples/custom_controls/src/main.rs:127
- Reusing
pathhere shadows the inline path variable; renaming this tostandalone_pathcould avoid confusion.
let path = format!("./output/{}.html", name);
docs/book/src/recipes/basic_charts/pie_charts.md:34
- Typo in
donout; it should likely be spelleddonut.
+{{#include ../../../../../examples/basic_charts/output/inline_grouped_donout_pie_charts.html}}
andrei-ng
force-pushed
the
fix-book-examples-after-refactor
branch
3 times, most recently
from
fbb3e95 to
95c126f
Compare
Signed-off-by: Andrei Gherghescu <8067229+andrei-ng@users.noreply.github.com>
andrei-ng
force-pushed
the
fix-book-examples-after-refactor
branch
from
95c126f to
805266d
Compare
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.
No description provided.