All Documents

• google_demo
  index.html
  Package
  Package
  PUBLIC
  Pydoctor pre-process Google-style docstrings to convert them to reStructuredText. All standard reStructuredText formatting will still works as expected.
• google_demo.module_level_variable1
  index.html#module_level_variable1
  Attribute
  Variable
  PUBLIC
  Module level variables may be documented in either the Attributes section of the module docstring, or in an inline docstring immediately following the variable.
• google_demo.module_level_variable2
  index.html#module_level_variable2
  Attribute
  Variable
  PUBLIC
  Module level variable documented inline.
• google_demo.function_with_types_in_docstring
  index.html#function_with_types_in_docstring
  Function
  Function
  PUBLIC
  Example function with types documented in the docstring.
• google_demo.function_with_pep484_type_annotations
  index.html#function_with_pep484_type_annotations
  Function
  Function
  PUBLIC
  Example function with PEP 484 type annotations.
• google_demo.module_level_function
  index.html#module_level_function
  Function
  Function
  PUBLIC
  This is an example of a module level function.
• google_demo.example_generator
  index.html#example_generator
  Function
  Function
  PUBLIC
  Generators have a Yields section instead of a Returns section.
• google_demo.ExampleError
  google_demo.ExampleError.html
  Class
  Exception
  PUBLIC
  Exceptions are documented in the same way as classes.
• google_demo.ExampleError.msg
  google_demo.ExampleError.html#msg
  Attribute
  Instance Variable
  PUBLIC
  Human readable string describing the exception.
• google_demo.ExampleError.code
  google_demo.ExampleError.html#code
  Attribute
  Instance Variable
  PUBLIC
  Exception error code.
• google_demo.ExampleError.__init__
  google_demo.ExampleError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• google_demo.ExampleClass
  google_demo.ExampleClass.html
  Class
  Class
  PUBLIC
  The summary line for a class docstring should fit on one line.
• google_demo.ExampleClass.attr1
  google_demo.ExampleClass.html#attr1
  Attribute
  Instance Variable
  PUBLIC
  Description of attr1.
• google_demo.ExampleClass.attr2
  google_demo.ExampleClass.html#attr2
  Attribute
  Instance Variable
  PUBLIC
  Description of attr2.
• google_demo.ExampleClass.__init__
  google_demo.ExampleClass.html#__init__
  Function
  Method
  PUBLIC
  Example of docstring on the __init__ method.
• google_demo.ExampleClass.attr3
  google_demo.ExampleClass.html#attr3
  Attribute
  Instance Variable
  PUBLIC
  Doc comment inline with attribute
• google_demo.ExampleClass.attr4
  google_demo.ExampleClass.html#attr4
  Attribute
  Instance Variable
  PUBLIC
  Doc comment before attribute, with type specified
• google_demo.ExampleClass.attr5
  google_demo.ExampleClass.html#attr5
  Attribute
  Instance Variable
  PUBLIC
  Docstring after attribute, with type specified.
• google_demo.ExampleClass.readonly_property
  google_demo.ExampleClass.html#readonly_property
  Attribute
  Property
  PUBLIC
  Properties should be documented in their getter method.
• google_demo.ExampleClass.readwrite_property
  google_demo.ExampleClass.html#readwrite_property
  Attribute
  Property
  PUBLIC
  Properties with both a getter and setter should only be documented in their getter method.
• google_demo.ExampleClass.readwrite_property.setter
  google_demo.ExampleClass.html#readwrite_property.setter
  Function
  Method
  PUBLIC
  Undocumented
• google_demo.ExampleClass.example_method
  google_demo.ExampleClass.html#example_method
  Function
  Method
  PUBLIC
  Class methods are similar to regular functions.
• google_demo.ExampleClass.__special__
  google_demo.ExampleClass.html#__special__
  Function
  Method
  PUBLIC
  Dunder methods are considered public and will be included in the output.
• google_demo.ExampleClass.__special_without_docstring__
  google_demo.ExampleClass.html#__special_without_docstring__
  Function
  Method
  PUBLIC
  Undocumented
• google_demo.ExampleClass._private
  google_demo.ExampleClass.html#_private
  Function
  Method
  PRIVATE
  Private members are any methods or attributes that start with an underscore and are not special.
• google_demo.ExampleClass._private_without_docstring
  google_demo.ExampleClass.html#_private_without_docstring
  Function
  Method
  PRIVATE
  Undocumented
• google_demo.ExamplePEP526Class
  google_demo.ExamplePEP526Class.html
  Class
  Class
  PUBLIC
  The summary line for a class docstring should fit on one line.
• google_demo.ExamplePEP526Class.attr1
  google_demo.ExamplePEP526Class.html#attr1
  Attribute
  Instance Variable
  PUBLIC
  Description of attr1.
• google_demo.ExamplePEP526Class.attr2
  google_demo.ExamplePEP526Class.html#attr2
  Attribute
  Instance Variable
  PUBLIC
  Description of attr2.