How do I document Python code (docstrings, Sphinx)?

Documenting Python code is essential for creating readable and maintainable software. A common practice is to use docstrings, which are special comments located at the beginning of modules, classes, methods, or functions. Tools like Sphinx can convert these docstrings into comprehensive documentation websites.

Example


        """
        This function adds two numbers together.
        
        Parameters:
        a (int): The first number.
        b (int): The second number.
        
        Returns:
        int: The sum of a and b.
        """
        def add(a, b):
            return a + b