You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
I have a project that uses "classic" style docstrings, that style/format gets sometimes called "Sphinx style" and sometimes "reST" style:
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
The text was updated successfully, but these errors were encountered: