Create documentation from python modules and other objects.
Latest release 20210306: Drop noise leaked into output.
Function is_dunder(name)
Test whether a name is a dunder name (__foo__).
Function module_doc(module, *, sort_key=<function <lambda> at 0x10922e280>, filter_key=<function <lambda> at 0x10922e310>, 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 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.
1 maintainer
Metadata
1 maintainer
Release files for cs-py-doc 20210306
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cs.py.doc-20210306.tar.gz | 4.2 kB | Details |
Release files / cs.py.doc-20210306.tar.gz
| Download URL | cs.py.doc-20210306.tar.gz |
|---|---|
| Size | 4.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d361baf51930310ead7b088aa9c89169c7fe9adc01e99cdd31d10562339fedcf
|
|
BLAKE2b-256 checksum How to use checksums |
9e199658b6a68e6c14daefa55a7c70c6a58f8913bd22b006a7f2a8e64ab5b5f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.9.2
|
