How to use the restructured-text docstring style?
See original GitHub issueHi, Thanks for the awesome package!
Trying to use mkdocstrings (version 0.14.0) with the restructured-text
docstring style.
Here’s my configuration:
::: path.to.Class
handler: python
selection:
docstring_style: restructured-text
Getting: mkdocstrings.handlers.base.CollectionError: 'restructured-text'
Also tried docstring_style: rest
and others with no luck.
Trying to follow this documentation, it is not clear how to make this work.
Issue Analytics
- State:
- Created 3 years ago
- Comments:8 (4 by maintainers)
Top Results From Across the Web
2. Example on how to document your Python docstrings
This class docstring shows how to use sphinx and rst syntax. The first line is brief explanation, which may be completed with a...
Read more >PEP 287 – reStructuredText Docstring Format
This PEP proposes that the reStructuredText markup be adopted as a standard markup format for structured plaintext documentation in Python ...
Read more >Python docstring reStructuredText style - gists · GitHub
The role text can include the type name and the method name; if it occurs within the description of a type, the type...
Read more >ReStructuredText Style Guide - LSST DM Developer Guide
This page describes how reStructuredText (reST) is written for DM ... Second, Python docstrings can only use subsection and subsubsection-level headings.
Read more >Specify types with docstrings | PyCharm Documentation
To specify the parameter types, follow these general steps · Press Ctrl+Alt+S and go to Editor | General |Smart Keys. · Place the...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Note that docs should probably explicitly mention
restructured-text
as an option 😃I got an error:
ValueError: 'restructured-text' is not a valid Parser
. I found out thatrestructured-text
has been renamed tosphinx
: