{"adoption": {"forks": 228, "observed_at": "2026-08-28T04:06:57.344454+00:00", "stars": 2510}, "canonical_url": "https://ross.abutalabs.com/products/pdoc", "card": {"archived": false, "artifact_type": "cli-tool", "description": "API Documentation for Python Projects", "domain": ["documentation", "developer-tools", "apis"], "enriched": true, "function": ["documentation", "api-documentation", "cli", "http-server"], "health_score": 74, "homepage": "https://pdoc.dev", "language": "Python", "license": "MIT-0", "license_family": "permissive", "maturity": "active", "member_repos": ["mitmproxy/pdoc"], "name": "mitmproxy/pdoc", "platform": ["python", "cli", "cross-platform"], "pushed_at": "2026-07-01T08:04:25+00:00", "repo": "mitmproxy/pdoc", "stars": 2510, "tags": ["docstring-rendering", "markdown-docs", "live-reload", "type-annotations", "html-generation", "python"], "topics": ["documentation", "python", "docstrings", "docs", "pdoc", "api-documentation", "python3", "api", "docstring", "documentation-tool", "documentation-generator"], "urls": [], "use_cases": ["generate api documentation for a python package", "render docstrings as html docs", "document a python library with type annotations", "preview python docs with live reload", "export python api docs to static html for github pages", "convert google-style or numpydoc docstrings to documentation"], "what_it_is": "pdoc is a zero-configuration documentation generator that auto-generates API documentation for Python projects from docstrings and type annotations. It renders Markdown docstrings into HTML, supports numpydoc and Google-style docstrings, and includes a live-reloading web server for previewing docs.", "when_to_avoid": ["you need multi-language documentation beyond Python", "you want a full docs site with tutorials and guides (consider MkDocs or Sphinx)", "you need reStructuredText docstring support"], "when_to_choose": ["you want zero-config API docs for a Python project", "your docstrings are Markdown, Google-style, or numpydoc", "you want first-class type annotation support and cross-linking", "you need a live-reloading docs preview server"]}, "data_as_of": "2026-08-30T08:39:29.467469+00:00", "members": [{"path": "/products/pdoc", "repo": "mitmproxy/pdoc", "role": "main", "score": 73}], "provenance": {"archived": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "artifact_type": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "description": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "domain": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "enriched": {"inputs": [], "kind": "computed", "method": "enrichment_status"}, "function": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "health_score": {"inputs": ["days_since_push", "days_since_release", "archived"], "kind": "computed", "method": "health_v1"}, "homepage": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "language": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "license": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "license_family": {"inputs": ["license"], "kind": "computed", "method": "license_family"}, "maturity": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "member_repos": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "name": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "platform": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "pushed_at": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "repo": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "stars": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "tags": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "topics": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "urls": {"kind": "observed", "observed_at": "2026-08-28T04:06:57.344454+00:00", "source": "github"}, "use_cases": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "what_it_is": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "when_to_avoid": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}, "when_to_choose": {"confidence": null, "enriched_at": "2026-08-30T02:26:26.422834+00:00", "kind": "inferred", "prompt_version": 1, "sources": [{"content_hash": "da7ea9f0bc25c4758994734d31aed1cc5979faf0909030b755328657e60b5653", "fetched_at": "2026-08-28T04:06:57.344454+00:00", "kind": "readme", "missing": false, "url": "https://github.com/mitmproxy/pdoc"}, {"content_hash": "154e623b78cb0a00f302656d754921f8e735c67a6088633b921efd7d4eade780", "fetched_at": "2026-08-29T10:08:55.147319+00:00", "kind": "homepage", "missing": false, "url": "https://pdoc.dev"}, {"content_hash": "96fce0518f2a9a0a1b6d30898cf1a191a7b5364aa807ec18695595b716089879", "fetched_at": "2026-08-29T10:08:55.178062+00:00", "kind": "site_page", "missing": false, "url": "https://pdoc.dev/docs/pdoc.html"}, {"content_hash": "6f04c880297caa0affd61c23836d0e394aa3c6a5223cda8029b2addff8e8becd", "fetched_at": "2026-08-29T10:08:55.182031+00:00", "kind": "registry_pypi", "missing": false, "url": "https://pypi.org/pypi/pdoc/json"}], "taxonomy_version": 1}}, "score": {"components": {"activity": 90, "longevity": 100, "rhythm": 35}, "computed_at": "2026-09-03T02:20:16.233290+00:00", "flags": ["no_releases"], "formula": "round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)", "inputs": {"age_days": 4777, "days_push": 63, "days_rel": null, "gap_med": null, "n_releases_24m": 0}, "score": 73, "version": 2}, "staleness": {"enrichment_outdated": false, "low_confidence": false, "scrape_days": 9, "stale_scrape": false}}