{"library":"pydoctor","title":"Pydoctor","description":"Pydoctor is a standalone API documentation generator that works by static analysis. It was primarily written to replace epydoc for the Twisted project, especially due to epydoc's difficulties with `zope.interface`. It aims to provide comprehensive API documentation for Python projects, supporting various docstring formats like epytext, reStructuredText, Google, and Numpy styles. The current version is 25.10.1 and it is actively maintained.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install pydoctor"],"cli":{"name":"pydoctor","version":"pydoctor 25.10.1"}},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# 1. Create a dummy Python package/module\nmkdir -p my_project/src/my_lib\necho \"\"\"\"\"\"A simple library.\"\"\"\"\" > my_project/src/my_lib/__init__.py\necho \"\"\"\"\"\"A simple module.\ndef greet(name: str) -> str:\n    \"\"\"Greets the given name.\n\n    :param name: The name to greet.\n    :type name: str\n    :return: A greeting message.\n    :rtype: str\n    \"\"\"\n    return f'Hello, {name}!'\n\"\"\" > my_project/src/my_lib/greeting.py\n\n# 2. Run pydoctor to generate documentation\ncd my_project\npydoctor --project-name=\"My Project API\" \\\n         --project-version=\"1.0.0\" \\\n         --html-output=docs/api \\\n         src/my_lib\n\n# 3. View the generated documentation (e.g., open docs/api/index.html)","lang":"bash","description":"Pydoctor is primarily a command-line interface (CLI) tool. This quickstart demonstrates how to create a minimal Python project and generate its API documentation using the `pydoctor` command-line utility. The `--html-output` option specifies the output directory, and the positional arguments are the paths to the Python source to be documented.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}