Skip to content

No support for classic Sphinx Style docstring format? #273

Closed
@johann-petrak

Description

@johann-petrak

I have a project that uses "classic" style docstrings, that style/format gets sometimes called "Sphinx style" and sometimes "reST" style:

"""
Some text to describe what the function does. 
This can span several lines.

:param param1: description of first parameter.
   can also span several lines if indented.
:param param2: another one
:returns: description of what is returned
"""

This will not detect the :param sections and format them properly in the generated HTML.

Am I doing this wrong or is this not supported?
In general, is it possible to somehow configure the expected docstring format or is everything supposed to get
auto-detected (so different files or even different parts in a file could have different formats)?

I am using pdoc version 0.9.1 with Python 3.7

Metadata

Metadata

Assignees

No one assigned

    Labels

    duplicateThis issue or pull request already exists

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions