Skip to content
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

Feature: Format using Sphinx docstring format #23

Closed
MyMaloks opened this issue Apr 9, 2020 · 2 comments
Closed

Feature: Format using Sphinx docstring format #23

MyMaloks opened this issue Apr 9, 2020 · 2 comments

Comments

@MyMaloks
Copy link

MyMaloks commented Apr 9, 2020

My Python code is written using the Sphinx docstring format:
https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

:param [ParamName]: [ParamDescription], defaults to [DefaultParamVal]
:type [ParamName]: [ParamType](, optional)
...
:raises [ErrorType]: [ErrorDescription]
...
:return: [ReturnDescription]
:rtype: [ReturnType]

It would be really a great feature that mkautodoc detects it so that it format the doc such it is displayed on this repo home page.

@Erik-White
Copy link

This would be wonderful, even better if it could read the types from parameter type hints

@tomchristie
Copy link
Owner

That'd be cool, but it'd need to be someone else authoring a package to do that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants