Skip to content
Create a docstring given a module's symbol name.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests
.gitignore
LICENSE
README.md
setup.py
symboldoc.py

README.md

SymbolDoc

Scrutinizer Code Quality Code Coverage Build Status Python 3

Create a docstring given a module's symbol name.

Installation

pip3 install symboldoc

Usage example

$ symboldoc path/to/module.py my_function sphinx
"""Brief summary for method my_function

The first line is brief explanation, which may be completed with
a longer one.

- **parameters**, **types**, **return** and **return types**::

:param arg1: Description for arg1
:type arg1:
:param arg2: Description for arg2
:type arg2:
:return: return description
:rtype: The return type description
"""

Flavors

Name Available
Sphinx Sort of!
You can’t perform that action at this time.