Executable Books
Cross-Reference to API Documentation when using MyST Parser #1169
-
|
I am using the MyST parser (v3) and the sphinx-autoapi package in our documentation. For instance, I would like to link to this function in our documentation from a markdown page. Unfortunately, I did not find anything in the MyST documentation on how to cross-refence to specific parts of the auto-generated API documentation. The Sphinx documentation mentions the Help would be greatly appreciated! |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments
-
|
Heya, maybe check out https://myst-parser.readthedocs.io/en/latest/syntax/code_and_apis.html#documenting-whole-apis But yes any role can be used similar to rst, just swap the colons |
Beta Was this translation helpful? Give feedback.
-
|
Hey Chris! Many thanks - a simple did the trick for us. Native MyST markdown support in your autodoc2 also sounds pretty neat - I'll give it a try soon. |
Beta Was this translation helpful? Give feedback.
Heya, maybe check out https://myst-parser.readthedocs.io/en/latest/syntax/code_and_apis.html#documenting-whole-apis
But yes any role can be used similar to rst, just swap the colons
:for braces{