Skip to content

Commit

Permalink
Fix incorrect name for myst-example directive in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bizordec committed Aug 12, 2024
1 parent 3c8fe16 commit 08bafeb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/theme_result.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In developing the documentation for this theme, it became apparent that we neede
duplicating code samples to show both document source syntax and HTML rendering of the
document source code.

Introducing the :rst:dir:`rst-example` and :rst:dir:`md-example` directives! To use these
Introducing the :rst:dir:`rst-example` and :rst:dir:`myst-example` directives! To use these
directives, enable the :python:`"sphinx_immaterial.theme_result"` extension.

.. code-block:: python
Expand Down Expand Up @@ -191,7 +191,7 @@ directives, enable the :python:`"sphinx_immaterial.theme_result"` extension.
A :ref:`cross-reference link to this example <ref-this-example>`.
.. rst:directive:: md-example
.. rst:directive:: myst-example
This is really just an alias of the :rst:dir:`rst-example` for readability
in markdown document sources. It is meant to be used with Markdown code as
Expand All @@ -216,7 +216,7 @@ directives, enable the :python:`"sphinx_immaterial.theme_result"` extension.

.. code-block:: md
```{md-example} A showcase caption
```{myst-example} A showcase caption
:output-prefix: Which renders the following content:
:class: custom-css-class
:name: reference-this-example
Expand Down

0 comments on commit 08bafeb

Please sign in to comment.