As codebases grow, keeping track of all functions, methods, and classes becomes challenging. A clear documentation outline acts as a map of your code, simplifying navigation, reviews, and onboarding.

This tool analyzes your Python code to extract:

• Global Functions: Lists each function defined outside of classes along with their line number and a summary from the first line of their docstring (if available).
• Classes and Methods: For every class definition, the tool extracts the class name and docstring. It then scans within that class’s block to list all method definitions (with their respective docstring summaries), indented to show hierarchy.

Why is this useful?

• Quick Navigation: Easily locate where functions and classes are defined, with line numbers for fast reference.
• Documentation: Provides a starting point for writing comprehensive documentation or for automated documentation generation.
• Code Reviews & Debugging: A concise outline helps in understanding the structure and flow of the code, making reviews and debugging more efficient.

Example: For the following Python code:

class Calculator:
    """
    A simple calculator class.
    """
    def add(self, a, b):
        """
        Adds two numbers.
        """
        return a + b

def greet(name):
    """
    Greets a person.
    """
    return f"Hello, {name}!"
    

The tool might generate an outline like:

Line 1: Class 'Calculator' - A simple calculator class.
  Line 3: Method 'add' - Adds two numbers.
Line 7: Function 'greet' - Greets a person.
    

This outline provides a simple summary of your code’s structure, making it easier to locate functionality and understand the overall design.