Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix incorrect name for myst-example directive in docs #382

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

Fix incorrect name for myst-example directive in docs #382

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/theme_result.rst
View file
Open in desktop
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
Loading