pydocspec 0.0.0 API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Module Index

  • docspec - No module docstring; 0/6 variable, 6/6 functions, 14/14 classes documented
  • pydocspec - Pydocspec is a object specification for representing API documentation of a collection of related python modules. It offers facility to resolve names according to python lookups rules and provides additional informations.
    • astbuilder - Traverse module/packages directories, build and transform astroid AST into ApiObject instances.
    • astroidutils - Various bits of reusable code related to astroid.nodes.NodeNG node processing.
    • basebuilder - No module docstring; 0/2 variable, 1/1 function, 1/5 class documented
    • converter - Convert docspec objects to their pydocspec augmented version.
    • dottedname - No module docstring; 3/3 functions, 1/1 class documented
    • dupsafedict - No module docstring; 0/2 constant, 1/1 class documented
    • ext - Extensions sytem.
      • default - No package docstring; 1/2 module documented
        • dup - Handles objects created with the same name as an object that already exisist.
        • infer__all__ - No module docstring; 0/1 function, 2/2 classes documented
      • opt - Optional extensions packaged.
        • attrs - Handles attrs classes like:
        • dataclasses - Undocumented
        • django - Undocumented
        • docstring - Undocumented
        • zopeinterface - Undocumented
    • genericvisitor - General purpose visitor pattern implementation, with extensions.
    • processor - Processes the half baked model created by the builder to populate buch of fancy attributes.
      • class_attr - Helpers to populate attributes of Class instances.
      • data_attr - Helpers to populate attributes of Variable instances.
      • func_attr - Helpers to populate attributes of Function instances.
      • helpers - Helpers to help the helpers.
      • mod_attr - Helpers to populate attributes of Module instances.
    • specfactory - Create customizable docspec classes.
    • test - Undocumented
      • ext - Undocumented
        • test_attrs - Undocumented
        • test_dataclasses - Undocumented
        • test_django - Undocumented
        • test_docstring - Undocumented
        • test_zopeinterface - Undocumented
      • fixtures - Undocumented
      • test_astbuilder - No module docstring; 0/2 variable, 10/25 functions documented
      • test_astroidutils - Undocumented
      • test_c3linear - Undocumented
      • test_converter - Undocumented
      • test_introspect - Undocumented
      • test_packages - No module docstring; 0/1 variable, 2/5 functions documented
      • test_pydocspec - No module docstring; 1/5 function documented
      • test_visitors - Undocumented
    • tmp - Undocumented
    • visitors - Useful visitors for AST and pydocspec.ApiObject instances.
    • __main__ - Undocumented
    • _c3linear - Compute method resolution order. Implements Class.mro attribute.
    • _docspec - Mirrors docspec model, but without using dataclasses (and without deprecated attributes).
    • _model - Like the docspec classes, but with ast attributes and few goodies added such that efficient processing can be done on these objects afterwards.
API Documentation for pydocspec 0.0.0, generated by pydoctor 22.5.0.dev0 at 2022-04-29 00:33:08.