diff --git a/doc/dev/sphinx_notes.md b/doc/dev/sphinx_notes.md index 7f3d01c..353de50 100644 --- a/doc/dev/sphinx_notes.md +++ b/doc/dev/sphinx_notes.md @@ -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!\ @@ -47,4 +47,4 @@ To add code blocks within the docstrings of classes or functions, use the `::` m RE.subscribe(lambda name, document: ...) ... """ -``` \ No newline at end of file +```