{"library":"pdoc3","title":"pdoc3","description":"pdoc3 is a Python library and command-line tool that automatically generates API documentation from your Python project's docstrings and type annotations. It supports various docstring formats like Markdown, numpydoc, and Google-style, and can output documentation in HTML or PDF formats. As an actively maintained fork of the original `pdoc` project, it focuses on Python 3+ compatibility and ease of use, aiming to provide sensible documentation with minimal configuration.","language":"python","status":"active","last_verified":"Sat May 16","install":{"commands":["pip install pdoc3"],"cli":{"name":"pdoc3","version":"pdoc3 0.11.6"}},"imports":["import pdoc"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import pdoc\nimport os\n\n# Create a dummy module file for documentation\ndummy_module_content = \"\"\"\n\\\"\\\"\\\"\nA simple example module.\n\\\"\\\"\\\"\n\nclass MyClass:\n    \\\"\\\"\\\"\n    A sample class.\n\n    Attributes:\n        name (str): The name of the instance.\n    \\\"\\\"\\\"\n    def __init__(self, name: str):\n        self.name = name\n\n    def greet(self) -> str:\n        \\\"\\\"\\\"\n        Greets the user.\n        \\\"\\\"\\\"\n        return f\"Hello, {self.name}!\"\n\ndef my_function(value: int) -> int:\n    \\\"\\\"\\\"\n    A sample function.\n\n    Args:\n        value (int): An integer input.\n\n    Returns:\n        int: The input value multiplied by 2.\n    \\\"\\\"\\\"\n    return value * 2\n\"\"\"\nwith open(\"my_example_module.py\", \"w\") as f:\n    f.write(dummy_module_content)\n\n# Generate documentation for the module\n# Output to a 'docs' directory\npdoc.pdoc(\"my_example_module\", output_directory=\"docs\")\n\nprint(\"Documentation generated in 'docs/' directory.\")\nprint(\"You can view it by opening docs/my_example_module.html\")\n\n# Clean up the dummy module file\nos.remove(\"my_example_module.py\")\n# To clean up the generated documentation directory:\n# import shutil\n# shutil.rmtree(\"docs\")","lang":"python","description":"This quickstart demonstrates how to generate HTML documentation for a simple Python module using pdoc3 programmatically. It creates a temporary Python file, generates docs into a 'docs/' directory, and then cleans up the temporary file. For command-line usage, simply run `pdoc your_module_or_package`.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-16","installed_version":"0.11.6","pypi_latest":"0.11.6","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":2,"avg_import_s":0.45,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.37,"mem_mb":9,"disk_size":"21.6M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.9,"import_time_s":0.28,"mem_mb":9,"disk_size":"22M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.45,"mem_mb":10.6,"disk_size":"24.1M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.9,"import_time_s":0.4,"mem_mb":10.6,"disk_size":"25M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.65,"mem_mb":10.5,"disk_size":"15.8M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.8,"import_time_s":0.61,"mem_mb":10.5,"disk_size":"16M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.64,"mem_mb":10.3,"disk_size":"15.5M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.8,"import_time_s":0.58,"mem_mb":10.3,"disk_size":"16M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.27,"mem_mb":8.1,"disk_size":"21.5M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"pdoc3","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":2.4,"import_time_s":0.24,"mem_mb":8.1,"disk_size":"22M"}]}}