Jak utworzyć dokumentację za pomocą Pydoc?

Kolejna rzecz, którą ludzie mogą uznać za przydatną...pamiętaj, aby pominąć". py " w nazwie Twojego modułu. Na przykład, jeśli próbujesz wygenerować dokumentację dla 'original' w 'original.py':

yourcode_dir$ pydoc -w original.py
no Python documentation found for 'original.py'

yourcode_dir$ pydoc -w original
wrote original.html

Pydoc jest fantastyczny do generowania dokumentacji, ale dokumentacja musi być napisana w pierwszej kolejności. Musisz mieć docstringi w kodzie źródłowym, o czym wspomniał RocketDonkey w komentarzach:

"""
This example module shows various types of documentation available for use
with pydoc.  To generate HTML documentation for this module issue the
command:

    pydoc -w foo

"""

class Foo(object):
    """
    Foo encapsulates a name and an age.
    """
    def __init__(self, name, age):
        """
        Construct a new 'Foo' object.

        :param name: The name of foo
        :param age: The ageof foo
        :return: returns nothing
        """
        self.name = name
        self.age = age

def bar(baz):
    """
    Prints baz to the display.
    """
    print baz

if __name__ == '__main__':
    f = Foo('John Doe', 42)
    bar("hello world")

Pierwszy docstring zawiera instrukcje do tworzenia dokumentacji za pomocą pydoc. Istnieją przykłady różnych typów docstringów, dzięki czemu można zobaczyć, jak wyglądają one podczas generowania za pomocą pydoc.