All Documents

• restructuredtext_demo
  index.html
  Package
  Package
  PUBLIC
  Few general reStructuredText formating markups are documented here.
• restructuredtext_demo.constants
  restructuredtext_demo.constants.html
  Module
  Module
  PUBLIC
  Module demonstrating the constant representations.
• restructuredtext_demo.demo_restructuredtext_module
  restructuredtext_demo.demo_restructuredtext_module.html
  Module
  Module
  PUBLIC
  This is a module demonstrating reST code documentation features.
• restructuredtext_demo.demo_restructuredtext_module.Parser
  restructuredtext_demo.demo_restructuredtext_module.html#Parser
  Attribute
  Type Alias
  PUBLIC
  Type aliases are documented as such and their value is shown just like constants.
• restructuredtext_demo.demo_restructuredtext_module.LANG
  restructuredtext_demo.demo_restructuredtext_module.html#LANG
  Attribute
  Constant
  PUBLIC
  This is a constant. See constants for more examples.
• restructuredtext_demo.demo_restructuredtext_module.lang
  restructuredtext_demo.demo_restructuredtext_module.html#lang
  Attribute
  Constant
  PUBLIC
  This is also a constant, but annotated with typing.Final.
• restructuredtext_demo.demo_restructuredtext_module.demo_product_deprecated
  restructuredtext_demo.demo_restructuredtext_module.html#demo_product_deprecated
  Function
  Function
  PUBLIC
  Undocumented
• restructuredtext_demo.demo_restructuredtext_module.demo_fields_docstring_arguments
  restructuredtext_demo.demo_restructuredtext_module.html#demo_fields_docstring_arguments
  Function
  Function
  PUBLIC
  Fields are used to describe specific properties of a documented object.
• restructuredtext_demo.demo_restructuredtext_module.demo_consolidated_fields
  restructuredtext_demo.demo_restructuredtext_module.html#demo_consolidated_fields
  Function
  Function
  PUBLIC
  Fields can be condensed into one "consolidated" field. Looks better in plain text.
• restructuredtext_demo.demo_restructuredtext_module.demo_typing_arguments
  restructuredtext_demo.demo_restructuredtext_module.html#demo_typing_arguments
  Function
  Function
  PUBLIC
  Type documentation can be extracted from standard Python type hints.
• restructuredtext_demo.demo_restructuredtext_module.demo_long_function_and_parameter_names__this_indeed_very_long
  restructuredtext_demo.demo_restructuredtext_module.html#demo_long_function_and_parameter_names__this_indeed_very_long
  Function
  Function
  PUBLIC
  Long names and annotations should display on several lines when they don't fit in a single line.
• restructuredtext_demo.demo_restructuredtext_module.demo_cross_reference
  restructuredtext_demo.demo_restructuredtext_module.html#demo_cross_reference
  Function
  Function
  PUBLIC
  The inline markup construct `object` is used to create links to the documentation for other Python objects. 'text' is the text that should be displayed for the link, and 'object' is the name of the Python object that should be linked to.
• restructuredtext_demo.demo_restructuredtext_module.demo_overload
  restructuredtext_demo.demo_restructuredtext_module.html#demo_overload
  Function
  Function
  PUBLIC
  Overload signatures appear without the main signature and with @overload decorator.
• restructuredtext_demo.demo_restructuredtext_module.demo_undocumented
  restructuredtext_demo.demo_restructuredtext_module.html#demo_undocumented
  Function
  Function
  PUBLIC
  Undocumented
• restructuredtext_demo.demo_restructuredtext_module._PrivateClass
  restructuredtext_demo.demo_restructuredtext_module._PrivateClass.html
  Class
  Class
  PRIVATE
  This is the docstring of a private class.
• restructuredtext_demo.demo_restructuredtext_module._PrivateClass.method_inside_private
  restructuredtext_demo.demo_restructuredtext_module._PrivateClass.html#method_inside_private
  Function
  Method
  PUBLIC
  A public method inside a private class.
• restructuredtext_demo.demo_restructuredtext_module._PrivateClass._private_inside_private
  restructuredtext_demo.demo_restructuredtext_module._PrivateClass.html#_private_inside_private
  Function
  Method
  PRIVATE
  Returns something. :rtype: list
• restructuredtext_demo.demo_restructuredtext_module.DemoClass
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html
  Class
  Class
  PUBLIC
  This is the docstring of this class.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.__init__
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#__init__
  Function
  Method
  PUBLIC
  Documentation for class initialization.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_only
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_only
  Attribute
  Property
  PUBLIC
  This is a read-only property.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_only_deprecated
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_only_deprecated
  Attribute
  Property
  PUBLIC
  This is a deprecated read-only property.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_and_write
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_and_write
  Attribute
  Property
  PUBLIC
  This is a read-write property.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_and_write.setter
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_and_write.setter
  Function
  Method
  PUBLIC
  This is a docstring for setter.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_and_write_delete
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_and_write_delete
  Attribute
  Property
  PUBLIC
  This is a read-write-delete property.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_and_write_delete.setter
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_and_write_delete.setter
  Function
  Method
  PUBLIC
  This is a docstring for setter.
• restructuredtext_demo.demo_restructuredtext_module.DemoClass.read_and_write_delete.deleter
  restructuredtext_demo.demo_restructuredtext_module.DemoClass.html#read_and_write_delete.deleter
  Function
  Method
  PUBLIC
  This is a docstring for deleter.
• restructuredtext_demo.demo_restructuredtext_module.IContact
  restructuredtext_demo.demo_restructuredtext_module.IContact.html
  Class
  Interface
  PUBLIC
  Example of an interface with schemas.
• restructuredtext_demo.demo_restructuredtext_module.IContact.first
  restructuredtext_demo.demo_restructuredtext_module.IContact.html#first
  Attribute
  Attribute
  PUBLIC
  First name
• restructuredtext_demo.demo_restructuredtext_module.IContact.email
  restructuredtext_demo.demo_restructuredtext_module.IContact.html#email
  Attribute
  Attribute
  PUBLIC
  Electronic mail address
• restructuredtext_demo.demo_restructuredtext_module.IContact.address
  restructuredtext_demo.demo_restructuredtext_module.IContact.html#address
  Attribute
  Attribute
  PUBLIC
  Postal address
• restructuredtext_demo.demo_restructuredtext_module.IContact.send_email
  restructuredtext_demo.demo_restructuredtext_module.IContact.html#send_email
  Function
  Method
  PUBLIC
  Undocumented
• restructuredtext_demo.constants.A_DICT
  restructuredtext_demo.constants.html#A_DICT
  Attribute
  Constant
  PUBLIC
  The value of a constant is rendered with syntax highlighting. Internal and external links are generated to references of classes/functions used inside the constant
• restructuredtext_demo.constants.A_STIRNG
  restructuredtext_demo.constants.html#A_STIRNG
  Attribute
  Constant
  PUBLIC
  Strings are always rendered in single quotes, and appropriate escaping is added when required.
• restructuredtext_demo.constants.A_MULTILINE_STRING
  restructuredtext_demo.constants.html#A_MULTILINE_STRING
  Attribute
  Constant
  PUBLIC
  Multiline strings are always rendered in triple quotes.
• restructuredtext_demo.constants.A_LIST
  restructuredtext_demo.constants.html#A_LIST
  Attribute
  Constant
  PUBLIC
  Nested objects are colorized.
• restructuredtext_demo.constants.FUNCTION_CALL
  restructuredtext_demo.constants.html#FUNCTION_CALL
  Attribute
  Constant
  PUBLIC
  Function calls are colorized.
• restructuredtext_demo.constants.OPERATORS
  restructuredtext_demo.constants.html#OPERATORS
  Attribute
  Constant
  PUBLIC
  Operators are colorized and parenthesis are added when syntactically required.
• restructuredtext_demo.constants.UNSUPPORTED
  restructuredtext_demo.constants.html#UNSUPPORTED
  Attribute
  Constant
  PUBLIC
  A lot of objects can be colorized: function calls, strings, lists, dicts, sets, frozensets, operators, annotations, names, compiled regular expressions, etc. But when dealing with usupported constructs, like lamba functions, it will display the value without colorization.
• restructuredtext_demo.constants.RE_STR
  restructuredtext_demo.constants.html#RE_STR
  Attribute
  Constant
  PUBLIC
  Regular expressions have special colorizing that add syntax highlight to the regex components.
• restructuredtext_demo.constants.RE_WITH_UNICODE
  restructuredtext_demo.constants.html#RE_WITH_UNICODE
  Attribute
  Constant
  PUBLIC
  Unicode is supported in regular expressions.
• restructuredtext_demo.constants.RE_MULTILINE
  restructuredtext_demo.constants.html#RE_MULTILINE
  Attribute
  Constant
  PUBLIC
  Undocumented