Create documentation from python modules and other objects.
Project description
Create documentation from python modules and other objects.
Latest release 20240630: module_doc: insert the class usage message for subclasses of BaseCommand.
Function is_dunder(name)
Test whether a name is a dunder name (__
foo__
).
Function module_doc(module, *, sort_key=<function <lambda> at 0x109353eb0>, filter_key=<function <lambda> at 0x109353f40>, method_names=None)
Fetch the docstrings from a module and assemble a MarkDown document.
Parameters:
module
: the module or module name to inspectsort_key
: optional key for sorting names in the documentation; default:name
- filter_key`: optional test for a key used to select or reject keys to appear in the documentation
method_names
: optional list of method names to document; the default is to document__init__
, then CONSTANTS, the dunders, then other public names
Function obj_docstring(obj)
Return a docstring for obj
which has been passed through stripped_dedent
.
This function uses obj.__doc__
if it is not None
,
otherwise getcomments(obj)
if that is not None
,
otherwise ''
.
The chosen string is passed through stripped_dedent
before return.
Release Log
Release 20240630: module_doc: insert the class usage message for subclasses of BaseCommand.
Release 20240422: module_doc: only list things in all if provided.
Release 20240412: module_doc: classes: MRO: suppress classes which are not immediate superclasses.
Release 20220311: module_doc: class members no longer rendered as headings, too verbose.
Release 20210306: Drop noise leaked into output.
Release 20210123:
- module_doc: include properties/descriptors.
- DISTINFO: this is not Python 2 compatible, drop tag.
Release 20200718:
- New is_dunder(name) function to test whether name is a dunder name.
- module_doc: new method_names parameter to report only specific attributes from a class - default is all public names and most dunder methods - things without docs are not reported.
- Assorted small changes.
Release 20200521: Initial PyPI release.
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
Built Distribution
Hashes for cs.py.doc-20240630-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 405b750ecf32d5cd21d044cd794b39bb11f20bef947fbd974fef620cd8fc2641 |
|
MD5 | 8ba2d5b1466056a98e3678391d91696a |
|
BLAKE2b-256 | b4320660c557583766a3650fa2f594eb623913ebc36fad4e07ec28f4cfb5813e |