Skip to content

Commit 7852e3b

Browse files
Bizordec2bndy5
authored andcommitted
Fix incorrect name for myst-example directive in docs
1 parent 0a57b77 commit 7852e3b

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/theme_result.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In developing the documentation for this theme, it became apparent that we neede
55
duplicating code samples to show both document source syntax and HTML rendering of the
66
document source code.
77

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

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

217217
.. code-block:: md
218218
219-
```{md-example} A showcase caption
219+
```{myst-example} A showcase caption
220220
:output-prefix: Which renders the following content:
221221
:class: custom-css-class
222222
:name: reference-this-example

0 commit comments

Comments
 (0)