We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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.
The text was updated successfully, but these errors were encountered:
This would be wonderful, even better if it could read the types from parameter type hints
Sorry, something went wrong.
That'd be cool, but it'd need to be someone else authoring a package to do that.
No branches or pull requests
My Python code is written using the Sphinx docstring format:
https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
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.
The text was updated successfully, but these errors were encountered: