Skip to content

No support for classic Sphinx Style docstring format? #273

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.

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

Closed
johann-petrak opened this issue Oct 17, 2020 · 1 comment · May be fixed by #274
Closed

No support for classic Sphinx Style docstring format? #273

johann-petrak opened this issue Oct 17, 2020 · 1 comment · May be fixed by #274
Labels
duplicate This issue or pull request already exists

Comments

@johann-petrak
Copy link
Contributor

johann-petrak commented Oct 17, 2020

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

@kernc
Copy link
Member

kernc commented Oct 17, 2020

Duplicate of #110. Please subscribe to that issue for updates if interested.

There was some preliminary work in #198, but nothing acceptable so far. Contributions welcome!

@kernc kernc closed this as completed Oct 17, 2020
@kernc kernc added the duplicate This issue or pull request already exists label Oct 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists
Development

Successfully merging a pull request may close this issue.

2 participants