Metadata-Version: 2.1
Name: cs.py.doc
Version: 20210306
Summary: Create documentation from python modules and other objects.
Home-page: https://bitbucket.org/cameron_simpson/css/commits/all
Author: Cameron Simpson
Author-email: cs@cskk.id.au
License: GNU General Public License v3 or later (GPLv3+)
Description: 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 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
        
        ## 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.
Keywords: python2,python3
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Description-Content-Type: text/markdown
