Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/en/introduction/what-is-esp-docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,17 @@ It creates and adds the espidf.sty LaTeX package to the output directory, which

The ``include-build-file`` directive is like the built-in ``include-file`` directive, but the file path is evaluated relative to ``build_dir``.

:project_file:`Docs Embed <src/esp_docs/esp_extensions/docs_embed/plugin.py>`
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

This is a Sphinx extension to embed Wokwi simulator into the documentation.
The extension provides two directives: ``.. wokwi::`` and ``.. wokwi-example::``.

- ``.. 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.

See :doc:`Wokwi Embed <../writing-documentation/docs-embed>` for more information and examples.

IDF-Specific Extensions
^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
Loading