Add Wokwi diagram support and utility functions #18
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
JakubAndrysek
force-pushed
the
extensions/wokwi_embed
branch
from
c05a6f4 to
b54291a
Compare
Author
|
PR is ready from my side. Please look at it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR adds a new Sphinx plugin
docs-embedthat provides directives to embed the Wokwi simulator directly into the documentation.It also adds support for embedding Arduino examples just by linking the example path.
The plugin adds two new directives:
.. wokwi::directive embeds a Wokwi diagram specified by JSON file and firmware binary file URLs... wokwi-example::directive embeds a Wokwi example from the docs folder. Currently supports only Arduino framework examples.PR also adds a CLI command to maintain the
ci.ymlfile used by the Arduino ESP32 framework to prepare tests for web examples.The plugin was tested together with Arduino ESP32 fork, and the compilation and deployment work fine.
The last change which has to be done is to replace the Wokwi Client JS URL with the latest published version.It is published on NPM.But I am still waiting for the publishing.