generate README from python docstrings
Project description
Installation
$ [sudo] pip install readme-docstring
Examples
example with readme-generator
class Readme(readme_generator.Readme):
order = [..., "classes", "functions", ...]
def classes(self):
classes = self.getclasses()
return readme_docstring.Classes(classes)
def functions(self):
functions = self.getfunctions()
return readme_docstring.Functions(functions)
custom table
class ExecutableModules(readme_docstring.Table):
columns = ["usage", "`__doc__`"]
def __init__(self,modules):
self.objects = modules
def getleftcell(self, obj):
default = "python -m %s" % obj.__name__.replace(".__main__", "")
return "`%s`" % getattr(obj, "USAGE", default)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for readme-docstring-2020.12.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d88e5501c3ad9bca6b16e0779c9c521ff714be690ee667fed844d48c216e3242 |
|
MD5 | 0785688d4dfc3e3f54e44bb39e84408c |
|
BLAKE2b-256 | ce6a8f10137435273c1ed0fbd15a99defce3f3902d1a92179606e2483c97c08d |