picos.apidoc

Functions to support the automatic API documentation.

The environment variable PICOS_WARN_MISSING_DOCSTRINGS can be set to warn about missing docstrings for top level objects of a module.

Outline

Functions

api_end

Mark the end of a module’s content.

api_start

Mark the start of a module’s content.

Functions

api_end

picos.apidoc.api_end(startGlobals, endGlobals)[source]

Mark the end of a module’s content.

Store the returned value in __all__.

api_start

picos.apidoc.api_start(theGlobals)[source]

Mark the start of a module’s content.

Store the returned value and pass it to api_end.