Examples

• Basic Usage
  • Introduction
  • Simple Function Documentation
  • Exception Documentation
  • Multiple Exception Types
  • Preserving Existing Docstrings
  • Optional Parameters and Defaults
  • Rendering Styles
• Classes
  • Introduction
  • Simple Class Documentation
  • Class Variables versus Instance Variables
  • Scanning Unannotated Attributes
  • Method Documentation
  • Recursive Documentation with Introspection
  • Property Documentation
  • Fragment Integration
• Modules
  • Introduction
  • Basic Module Documentation
  • TypeAlias Documentation
  • Scanning Unannotated Attributes
  • Package Initialization with Recursive Documentation
  • Real-World Example: dynadoc Self-Documentation
  • Automatic __all__ Support
  • Configuration File Processing Example
  • Module Documentation Best Practices
• Fragments
  • Introduction
  • Basic Fragment Tables
  • Combining Doc and Fname
  • Module-Level Fragments
  • Class-Level Fragments
  • Storing Fragments on Classes
  • Storing Fragments on Modules
  • Error Handling
  • Real-World Example: dynadoc Fragments
  • Fragment Best Practices
• Configuration
  • Introduction
  • Context Objects
  • Fragment Rectification
  • Introspection Control
  • Selective Introspection
  • Class Introspection Controls
  • Custom Visibility Decisions
  • Annotation Resolution
  • Combining Configurations
  • Practical Configuration Examples
  • Troubleshooting
  • Configuration Best Practices
• Advanced Topics
  • Introduction
  • Custom Renderers
  • Error Handling Strategies
  • Custom Introspection Limiters
  • Visibility Control
  • Controlling Attribute Value Display
  • Stringified Annotations Support
  • Performance Optimization
  • Extension Patterns
  • Best Practices for Advanced Usage