question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

How to use the restructured-text docstring style?

See original GitHub issue

Hi, 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:closed
  • Created 3 years ago
  • Comments:8 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
omri374commented, Feb 18, 2021

Note that docs should probably explicitly mention restructured-text as an option 😃

0reactions
illagrenancommented, Jul 25, 2022

I got an error: ValueError: 'restructured-text' is not a valid Parser. I found out that restructured-text has been renamed to sphinx:

plugins:
  - mkdocstrings:
      handlers:
        python:
          selection:
            docstring_style: sphinx

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found