twisted.python._pydoctor module documentation

Part of twisted.python View Source

Support for a few things specific to documenting Twisted using pydoctor.

FIXME: https://github.com/twisted/pydoctor/issues/106 This documentation does not link to pydoctor API as there is no public API yet.

Class HeadRequest A request for the HEAD HTTP method.
Class TwistedSphinxInventory Custom SphinxInventory to work around broken external references to Sphinx.
Function getDeprecated With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator.
Class TwistedModuleVisitor No class docstring; 2/2 methods documented
Function versionToUsefulObject Change an AST Version() to a real one.
Function deprecatedToUsefulText Change a @deprecated to a display string.
Class TwistedFunction Undocumented
Class TwistedASTBuilder Undocumented
Class TwistedSystem A PyDoctor "system" used to generate the docs.
def getDeprecated(self, decorators): (source)

With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator.

def versionToUsefulObject(version): (source)

Change an AST Version() to a real one.

def deprecatedToUsefulText(name, deprecated): (source)

Change a @deprecated to a display string.

API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.