API Documentation

• dataclass_documenter package
  • Submodules
  • dataclass_documenter.dataclass_documenter module
    • DataclassDocumenter
      • DataclassDocumenter.__init__()
      • DataclassDocumenter.docstring
      • DataclassDocumenter.fields
      • DataclassDocumenter.get_markdown()
      • DataclassDocumenter.get_param_desc()
      • DataclassDocumenter.get_param_type()
      • DataclassDocumenter.get_yaml()
      • DataclassDocumenter.get_yaml_blocks()
      • DataclassDocumenter.params
  • dataclass_documenter.main module
    • DataclassLoaderError
    • import_dcls_from_file()
    • import_dcls_from_module()
    • main()
    • run_main()
  • dataclass_documenter.typing module
    • get_type_name()
    • is_optional()
    • strip_optional()
    • type_to_string()
  • Module contents
    • DataclassDocumenter
      • DataclassDocumenter.__init__()
      • DataclassDocumenter.docstring
      • DataclassDocumenter.fields
      • DataclassDocumenter.get_markdown()
      • DataclassDocumenter.get_param_desc()
      • DataclassDocumenter.get_param_type()
      • DataclassDocumenter.get_yaml()
      • DataclassDocumenter.get_yaml_blocks()
      • DataclassDocumenter.params