readme-docstring 2019.3.9

generate README from python docstrings

Install

[sudo] pip install readme-docstring

Classes

class	__doc__
readme_docstring.Classes	classes table class. attrs: classes
readme_docstring.Functions	functions table class. attrs: functions
readme_docstring.Table	abstract table class. attrs: headers, objects

Functions

function	__doc__
readme_docstring.getclasses()	return a list of classes defined in __all__
readme_docstring.getdoc(obj)	return first line of an object docstring
readme_docstring.getfunctions()	return a list of functions defined in __all__
readme_docstring.getmembers()	return all the members defined in __all__ in a list of (name, value) pairs
readme_docstring.getmodules()	return a list of modules
readme_docstring.getspec(routine)	return a string with Python routine specification

Examples

example with readme-generator

class Readme(readme_generator.Readme):
    def classes(self):
        return readme_docstring.Classes()

    def functions(self):
        return readme_docstring.Functions()

custom table

class Cli(readme_docstring.Table):
    columns = ["usage", "`__doc__`"]

    def __init__(self):
        self.objects = list(filter(lambda m: hasattr(m, "click"), setupcfg.getmodules()))

    def get_name(self, obj):
        default = "python -m %s" % obj.__name__.replace(".__main__", "")
        return "`%s`" % getattr(obj, "USAGE", default)

Related projects

• classifiers-generator - classifiers generator
• readme-badges - README.md badges
• readme-docstring - generate README.md from python docstrings
• readme-generator - README.md generator
• setupcfg-generator - setup.cfg generator
• travis-generator - .travis.yml generator

readme-generator