{"id":13412284,"url":"https://github.com/pdoc3/pdoc","last_synced_at":"2025-05-14T12:07:20.101Z","repository":{"id":37270398,"uuid":"163785224","full_name":"pdoc3/pdoc","owner":"pdoc3","description":" :snake: :arrow_right: :scroll:  Auto-generate API documentation for Python projects","archived":false,"fork":false,"pushed_at":"2024-08-19T06:47:58.000Z","size":1875,"stargazers_count":1128,"open_issues_count":115,"forks_count":145,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-10-29T15:38:11.106Z","etag":null,"topics":["api-documentation","docs","docs-generator","docstring","docstring-documentation","docstrings","documentation","documentation-dumper","documentation-generator","documentation-tool","generator","hacktoberfest","pdoc","python","python3"],"latest_commit_sha":null,"homepage":"https://pdoc3.github.io/pdoc/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pdoc3.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"kernc"}},"created_at":"2019-01-02T02:32:40.000Z","updated_at":"2024-10-28T13:49:02.000Z","dependencies_parsed_at":"2024-01-14T04:43:48.271Z","dependency_job_id":"7c4ca421-c189-4d4f-b480-8fe26c5fe2a2","html_url":"https://github.com/pdoc3/pdoc","commit_stats":{"total_commits":540,"total_committers":59,"mean_commits":9.152542372881356,"dds":"0.44074074074074077","last_synced_commit":"3ecfbcfb658c5be9ee6ab572b63db2cb5e1c29e1"},"previous_names":[],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdoc3%2Fpdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdoc3%2Fpdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdoc3%2Fpdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pdoc3%2Fpdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pdoc3","download_url":"https://codeload.github.com/pdoc3/pdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247962605,"owners_count":21024871,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","docs","docs-generator","docstring","docstring-documentation","docstrings","documentation","documentation-dumper","documentation-generator","documentation-tool","generator","hacktoberfest","pdoc","python","python3"],"created_at":"2024-07-30T20:01:22.964Z","updated_at":"2025-04-09T02:18:24.394Z","avatar_url":"https://github.com/pdoc3.png","language":"Python","readme":"[![](https://i.imgur.com/kQOtbBk.png)](https://pdoc3.github.io/pdoc/)\n\npdoc\n====\n[![Build Status](https://img.shields.io/github/actions/workflow/status/pdoc3/pdoc/ci.yml?branch=master\u0026style=for-the-badge)](https://github.com/pdoc3/pdoc/actions)\n[![Code Coverage](https://img.shields.io/codecov/c/gh/pdoc3/pdoc.svg?style=for-the-badge\u0026label=Covr)](https://codecov.io/gh/pdoc3/pdoc)\n[![Source lines of code](https://img.shields.io/endpoint?url=https%3A%2F%2Fghloc.vercel.app%2Fapi%2Fpdoc3%2Fpdoc%2Fbadge?filter=.py%26format=human\u0026style=for-the-badge\u0026label=SLOC\u0026color=green)](https://ghloc.vercel.app/pdoc3/pdoc)\n[![pdoc3 on PyPI](https://img.shields.io/pypi/v/pdoc3.svg?color=blue\u0026style=for-the-badge)](https://pypi.org/project/pdoc3)\n[![package downloads](https://img.shields.io/pypi/dd/pdoc3.svg?color=skyblue\u0026label=D/L\u0026style=for-the-badge)](https://pypistats.org/packages/pdoc3)\n[![total downloads](https://img.shields.io/pepy/dt/pdoc3?style=for-the-badge\u0026label=%E2%88%91\u0026color=skyblue)](https://pypistats.org/packages/pdoc3)\n[![GitHub Sponsors](https://img.shields.io/github/sponsors/kernc?color=pink\u0026style=for-the-badge\u0026label=%E2%99%A5)](https://github.com/sponsors/kernc)\n\nAuto-generate API documentation for Python 3+ projects.\n\n[**Project website**](https://pdoc3.github.io/pdoc/)\n\n[Documentation]\n\n[Documentation]: https://pdoc3.github.io/pdoc/doc/pdoc/\n\n\nInstallation\n------------\n\n    $ pip install pdoc3\n\n\nUsage\n-----\nPdoc will accept a Python module file, package directory or an import path.\n\n    $ pdoc your_project\n\nSee `pdoc --help` for more command-line switches and the [documentation]\nfor more usage examples.\n\n\nFeatures\n--------\n* Simple usage. Generate sensible API (+ prose) documentation without any\n  special configuration.\n* Support for common [docstrings formats] (Markdown, numpydoc, Google-style docstrings),\n  LaTeX math, and some [reST directives].\n* Support for [PEP 484] and [PEP 526] type annotations.\n* pdoc respects [`__all__`] when present.\n* Docstrings for overridden class members are [inherited] if unspecified.\n* Support for documenting module, class, and instance [_variables_] by traversing ASTs.\n* Automatic [cross-linking] of referenced identifiers.\n* Overriding docstrings generation with special module-level [`__pdoc__` dictionary].\n* Easily extended and [customized templates].\n* Built-in [development web server] for near-instant preview of rendered docstrings.\n\nThe above features are explained in more detail in pdoc's [documentation]\n(generated with pdoc).\n\n[docstrings formats]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-docstring-formats\n[reST directives]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-rest-directives\n[PEP 484]: https://www.python.org/dev/peps/pep-0484/\n[PEP 526]: https://www.python.org/dev/peps/pep-0526/\n[`__all__`]: https://pdoc3.github.io/pdoc/doc/pdoc/#what-objects-are-documented\n[inherited]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-inheritance\n[_variables_]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-for-variables\n[cross-linking]: https://pdoc3.github.io/pdoc/doc/pdoc/#linking-to-other-identifiers\n[`__pdoc__` dictionary]: https://pdoc3.github.io/pdoc/doc/pdoc/#overriding-docstrings-with-__pdoc__\n[customized templates]: https://pdoc3.github.io/pdoc/doc/pdoc/#custom-templates\n[development web server]: https://pdoc3.github.io/pdoc/doc/pdoc/#command-line-interface\n\n\nDevelopment\n-----------\nCheck [CONTRIBUTING.md](CONTRIBUTING.md) for hacking details.\n","funding_links":["https://github.com/sponsors/kernc"],"categories":["Python","Documentation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpdoc3%2Fpdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpdoc3%2Fpdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpdoc3%2Fpdoc/lists"}