Create documentation from python modules and other objects.
*Latest release 20240422*:
module_doc: only list things in __all__ if provided.
## Function `is_dunder(name)`
Test whether a name is a dunder name (`__`*foo*`__`).
## Function `module_doc(module, *, sort_key=<function <lambda> at 0x102b29000>, filter_key=<function <lambda> at 0x102b29090>, method_names=None)`
Fetch the docstrings from a module and assemble a MarkDown document.
Parameters:
* `module`: the module or module name to inspect
* `sort_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 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "cs.py.doc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python2, python3",
"author": null,
"author_email": "Cameron Simpson <cs@cskk.id.au>",
"download_url": "https://files.pythonhosted.org/packages/40/55/92bf3ab1e8ccaac9b1389862050a71bbf189263a317fade2d98a8ba554d9/cs.py.doc-20240422.tar.gz",
"platform": null,
"description": "Create documentation from python modules and other objects.\n\n*Latest release 20240422*:\nmodule_doc: only list things in __all__ if provided.\n\n## Function `is_dunder(name)`\n\nTest whether a name is a dunder name (`__`*foo*`__`).\n\n## Function `module_doc(module, *, sort_key=<function <lambda> at 0x102b29000>, filter_key=<function <lambda> at 0x102b29090>, method_names=None)`\n\nFetch the docstrings from a module and assemble a MarkDown document.\n\nParameters:\n* `module`: the module or module name to inspect\n* `sort_key`: optional key for sorting names in the documentation;\n default: `name`\n* filter_key`: optional test for a key used to select or reject keys\n to appear in the documentation\n* `method_names`: optional list of method names to document;\n the default is to document `__init__`, then CONSTANTS, the\n dunders, then other public names\n\n## Function `obj_docstring(obj)`\n\nReturn a docstring for `obj` which has been passed through `stripped_dedent`.\n\nThis function uses `obj.__doc__` if it is not `None`,\notherwise `getcomments(obj)` if that is not `None`,\notherwise `''`.\nThe chosen string is passed through `stripped_dedent` before return.\n\n# Release Log\n\n\n\n*Release 20240422*:\nmodule_doc: only list things in __all__ if provided.\n\n*Release 20240412*:\nmodule_doc: classes: MRO: suppress classes which are not immediate superclasses.\n\n*Release 20220311*:\nmodule_doc: class members no longer rendered as headings, too verbose.\n\n*Release 20210306*:\nDrop noise leaked into output.\n\n*Release 20210123*:\n* module_doc: include properties/descriptors.\n* DISTINFO: this is not Python 2 compatible, drop tag.\n\n*Release 20200718*:\n* New is_dunder(name) function to test whether name is a dunder name.\n* 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.\n* Assorted small changes.\n\n*Release 20200521*:\nInitial PyPI release.\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 or later (GPLv3+)",
"summary": "Create documentation from python modules and other objects.",
"version": "20240422",
"project_urls": {
"URL": "https://bitbucket.org/cameron_simpson/css/commits/all"
},
"split_keywords": [
"python2",
" python3"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23c1600cfb1d878624ef2ad2d47854b1945d3ec3c38dab83d3b01d8fe3245ec2",
"md5": "1e3febb2573fb5878a68e94012a40358",
"sha256": "77582f84f5c98afdde62ad03c598f6400c259cd1efe0ef7017f564b9f05dcc59"
},
"downloads": -1,
"filename": "cs.py.doc-20240422-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e3febb2573fb5878a68e94012a40358",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4435,
"upload_time": "2024-04-22T02:54:04",
"upload_time_iso_8601": "2024-04-22T02:54:04.179819Z",
"url": "https://files.pythonhosted.org/packages/23/c1/600cfb1d878624ef2ad2d47854b1945d3ec3c38dab83d3b01d8fe3245ec2/cs.py.doc-20240422-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "405592bf3ab1e8ccaac9b1389862050a71bbf189263a317fade2d98a8ba554d9",
"md5": "204e3c2ebf75a83d41a7d34c2af0ed1d",
"sha256": "e4c125ee7069c9002d908edc4a9865d56aa55d497d1098196c2fe6890ccbe4a3"
},
"downloads": -1,
"filename": "cs.py.doc-20240422.tar.gz",
"has_sig": false,
"md5_digest": "204e3c2ebf75a83d41a7d34c2af0ed1d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4315,
"upload_time": "2024-04-22T02:54:06",
"upload_time_iso_8601": "2024-04-22T02:54:06.085359Z",
"url": "https://files.pythonhosted.org/packages/40/55/92bf3ab1e8ccaac9b1389862050a71bbf189263a317fade2d98a8ba554d9/cs.py.doc-20240422.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 02:54:06",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "cameron_simpson",
"bitbucket_project": "css",
"lcname": "cs.py.doc"
}
JSON