Skip to content

Commit

Permalink
Update sphinx_notes.md
Browse files Browse the repository at this point in the history
Update link to Admonition
  • Loading branch information
davidkeymer authored Sep 30, 2024
1 parent 15383f8 commit aff0a67
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/dev/sphinx_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This repository uses sphinx with some addons to build documentation and then dep
We use the [MyST](https://myst-parser.readthedocs.io/en/latest/index.html) parser which lets us use a mixture of markdown and reStructuredText in documentation - though the latter is preferred by sphinx.

## Using MyST admonitions
To use [MyST admonitions](https://myst-parser.readthedocs.io/en/latest/sphinx_admonitions.html), you need to use backticks instead of triple colons, ie.
To use [MyST admonitions](https://myst-parser.readthedocs.io/en/latest/syntax/admonitions.html), you need to use backticks instead of triple colons, ie.

\`\`\`{tip}\
Let's give readers a helpful hint!\
Expand Down Expand Up @@ -47,4 +47,4 @@ To add code blocks within the docstrings of classes or functions, use the `::` m
RE.subscribe(lambda name, document: ...)
...
"""
```
```

0 comments on commit aff0a67

Please sign in to comment.