Create documentation from python modules and other objects.
Latest release 20200521: Initial PyPI release.
Function module_doc(module, *, sort_key=<function <lambda> at 0x10293b430>, filter_key=<function <lambda> at 0x1029bc310>)
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.lower()- 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 20200521: Initial PyPI release.
1 maintainer
Release files for cs-py-doc 20200521
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-20200521.tar.gz | 3.2 kB | Details |
Release files / cs.py.doc-20200521.tar.gz
| Download URL | cs.py.doc-20200521.tar.gz |
|---|---|
| Size | 3.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bbd9d637ecf33709aacedb2d6c6e136da845bff563caf46a820782531e957cea
|
|
BLAKE2b-256 checksum How to use checksums |
c0841cbc3bda2e3864f190b1cda81d52cc6b35f1d5ef7a8972d567bd1c9682a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7
|
