Create documentation from python modules and other objects.
Short summary:
-
is_dunder: Test whether a name is a dunder name (__foo__). -
module_doc: Fetch the docstrings from a module and assemble a MarkDown document. -
obj_docstring: Return a docstring forobjwhich has been passed throughstripped_dedent.
Functions
is_dunder(name)
Test whether a name is a dunder name (__foo__).
module_doc(module, *, sort_key=<function
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
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.
1 maintainer
Metadata
1 maintainer
Release files for cs-py-doc 20261016
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-20261016.tar.gz | 4.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cs_py_doc-20261016-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 9.0 kB
Release files / cs_py_doc-20261016.tar.gz
| Download URL | cs_py_doc-20261016.tar.gz |
|---|---|
| Size | 4.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0d4aafa6987603b090cdb5951db8d6b488469d552c2f566d1cdaac50f2228e09
|
|
BLAKE2b-256 checksum How to use checksums |
c74e92cd079890d253acb0ad93fbc9f933c78d72040316c2e7e713e46ebc8add
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
Release files / cs_py_doc-20261016-py2.py3-none-any.whl
| Download URL | cs_py_doc-20261016-py2.py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
18b854dae0735237ae498d2bea92c7d1e2afba4cb215845f316ef644312e7ad0
|
|
BLAKE2b-256 checksum How to use checksums |
fe32ca954a2862b58039c8e2eb7370275d013e938f8a808d3604e9c57d222954
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
