{"meta":{"name":"FindSoftware","page":"https://findsoftware.frbit.cloud/pdoc/","markdown":"https://findsoftware.frbit.cloud/pdoc.md","license":"https://creativecommons.org/licenses/by/4.0/","attribution":"FindSoftware, CC BY 4.0","note":"Attributes are recorded, never scored. An absent field means unknown, never zero and never bad."},"record":{"id":"pdoc","name":"pdoc","urls":{"home":"https://pdoc.dev","repository":"https://github.com/mitmproxy/pdoc","docs":"https://pdoc.dev/docs/pdoc.html"},"category":["ssg"],"description":"API documentation generator for Python projects that renders modules, classes and functions from their docstrings and type annotations into HTML.","maintainer":"Maximilian Hils","firstRelease":2013,"hosting":["python"],"language":"python","runtime":["python"],"runtimeMin":"python 3.10","templating":"jinja2","installMethod":"pip","licenseModel":"open-source","license":"MIT-0","currentMajor":"16","latestReleaseDate":"2025-10-27T00:00:00.000Z","githubStargazers":2519,"contributors":62,"packagistDownloads":null,"npmWeeklyDownloads":null,"ecosystemsMonthlyDownloads":1496003,"dependentRepos":388,"dependentPackages":192,"checkedAt":"2026-10-23T00:00:00.000Z","addedAt":"2026-10-23T00:00:00.000Z","sources":[{"field":"language","url":"https://api.github.com/repos/mitmproxy/pdoc","checkedAt":"2026-10-25T00:00:00.000Z"},{"field":"urls","url":"https://pdoc.dev/","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"urls","url":"https://api.github.com/repos/mitmproxy/pdoc","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"urls","url":"https://pdoc.dev/docs/pdoc.html","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"maintainer","url":"https://raw.githubusercontent.com/mitmproxy/pdoc/main/LICENSE","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"category","url":"https://github.com/mitmproxy/pdoc/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"runtime","url":"https://github.com/mitmproxy/pdoc/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"runtimeMin","url":"https://github.com/mitmproxy/pdoc/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"installMethod","url":"https://github.com/mitmproxy/pdoc/blob/main/README.md","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"templating","url":"https://pdoc.dev/docs/pdoc.html","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"license","url":"https://api.github.com/repos/mitmproxy/pdoc","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"licenseModel","url":"https://raw.githubusercontent.com/mitmproxy/pdoc/main/LICENSE","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"currentMajor","url":"https://pypi.org/pypi/pdoc/json","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"latestReleaseDate","url":"https://pypi.org/pypi/pdoc/json","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"firstRelease","url":"https://pypi.org/pypi/pdoc/json","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"githubStargazers","url":"https://api.github.com/repos/mitmproxy/pdoc","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"contributors","url":"https://api.github.com/repos/mitmproxy/pdoc/contributors?per_page=1","checkedAt":"2026-10-23T00:00:00.000Z"},{"field":"dependentRepos","url":"https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc","checkedAt":"2026-10-25T00:00:00.000Z"},{"field":"dependentPackages","url":"https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc","checkedAt":"2026-10-25T00:00:00.000Z"},{"field":"ecosystemsMonthlyDownloads","url":"https://packages.ecosyste.ms/api/v1/registries/pypi.org/packages/pdoc","checkedAt":"2026-10-25T00:00:00.000Z"}],"status":"active","ai":"authored"},"prose":"pdoc generates API documentation for Python projects. It imports the modules it is given, reads their docstrings and type annotations, and writes standalone HTML. The pdoc command includes a web server with live reloading, and the [pdoc documentation](https://pdoc.dev/docs/pdoc.html) describes its templates and options. The project is installed with pip and is maintained by Maximilian Hils.\n\n## Worth knowing\n\npdoc runs the code of the modules it documents, so those modules are imported on every run. The README recommends Sphinx for substantially more complex documentation needs and states that the project is not associated with the separate pdoc3 project."}