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

📚 DOCS: Note that autodoc expects rST docstrings #339

Merged
merged 3 commits into from
Mar 31, 2021
Merged

📚 DOCS: Note that autodoc expects rST docstrings #339

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a196599
📚 DOCS: Warn that autodoc expects rST docstrings, not Markdown.
john-hen Mar 31, 2021
334fb09
Update docs/using/howto.md
john-hen Mar 31, 2021
3e72395
Update docs/using/howto.md
john-hen Mar 31, 2021
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
10 changes: 8 additions & 2 deletions docs/using/howto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,9 @@ If you encounter any issues with this feature, please don't hesitate to report i
(howto/autodoc)=
## Use `sphinx.ext.autodoc` in Markdown files

The [sphinx.ext.autodoc](sphinx:sphinx.ext.autodoc) is currently hard-coded to write rST, and so can not be used as a conventional MyST directive.
Instead the special [eval-rst directive](syntax/directives/parsing) can be used to "wrap" the autodoc directives:
The [Sphinx extension `autodoc`](sphinx:sphinx.ext.autodoc), which pulls in code documentation from docstrings, is currently hard-coded to parse reStructuredText.
It is therefore incompatible with MyST's Markdown parser.
However, the special [`eval-rst` directive](syntax/directives/parsing) can be used to "wrap" `autodoc` directives:

````md
```{eval-rst}
Expand All @@ -102,6 +103,11 @@ As with other objects in MyST, this can then be referenced:
- Using the role `` {py:class}`myst_parser.mocking.MockRSTParser` ``: {py:class}`myst_parser.mocking.MockRSTParser`
- Using the Markdown syntax `[MockRSTParser](myst_parser.mocking.MockRSTParser)`: [MockRSTParser](myst_parser.mocking.MockRSTParser)

```{warning}
This expects docstrings to be written in reStructuredText.
We hope to support Markdown in the future, see [GitHub issue #228](https://github.com/executablebooks/MyST-Parser/issues/228).
```

## Show backticks inside raw markdown blocks

If you'd like to show backticks inside of your markdown, you can do so by nesting them
Expand Down