Create documentation from python modules and other objects.
Project description
Create documentation from python modules and other objects.
Latest 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.
Function is_dunder(name)
Test whether a name is a dunder name (__
foo__
).
Function module_doc(module, *, sort_key=<function <lambda> at 0x103d81e50>, filter_key=<function <lambda> at 0x103d81ee0>, 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
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 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
cs.py.doc-20200718.tar.gz
(4.0 kB
view hashes)