{"id":35250608,"url":"https://github.com/mkdocstrings/griffe-inherited-docstrings","last_synced_at":"2026-02-20T13:01:00.097Z","repository":{"id":207658479,"uuid":"707752518","full_name":"mkdocstrings/griffe-inherited-docstrings","owner":"mkdocstrings","description":"Griffe extension for inheriting docstrings.","archived":false,"fork":false,"pushed_at":"2025-09-05T15:17:17.000Z","size":866,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-21T17:40:52.880Z","etag":null,"topics":["docstrings","griffe","griffe-extension"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/griffe-inherited-docstrings/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"pawamoy","polar":"pawamoy"}},"created_at":"2023-10-20T15:21:11.000Z","updated_at":"2025-11-12T03:39:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"0916e697-2efb-46a3-840c-b18fb9d81d58","html_url":"https://github.com/mkdocstrings/griffe-inherited-docstrings","commit_stats":null,"previous_names":["mkdocstrings/griffe-inherited-docstrings"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/mkdocstrings/griffe-inherited-docstrings","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe-inherited-docstrings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe-inherited-docstrings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe-inherited-docstrings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe-inherited-docstrings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/griffe-inherited-docstrings/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe-inherited-docstrings/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29651964,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docstrings","griffe","griffe-extension"],"created_at":"2025-12-30T06:38:18.207Z","updated_at":"2026-02-20T13:01:00.091Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","funding_links":["https://github.com/sponsors/pawamoy","https://polar.sh/pawamoy"],"categories":[],"sub_categories":[],"readme":"# Griffe Inherited Docstrings\n\n[![ci](https://github.com/mkdocstrings/griffe-inherited-docstrings/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-inherited-docstrings/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://mkdocstrings.github.io/griffe-inherited-docstrings/)\n[![pypi version](https://img.shields.io/pypi/v/griffe-inherited-docstrings.svg)](https://pypi.org/project/griffe-inherited-docstrings/)\n[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe-inherited-docstrings:gitter.im)\n\nGriffe extension for inheriting docstrings.\n\n## Installation\n\n```bash\npip install griffe-inherited-docstrings\n```\n\n## Usage\n\nWith Python:\n\n```python\nimport griffe\n\ngriffe.load(\"...\", extensions=griffe.load_extensions([\"griffe_inherited_docstrings\"]))\n```\n\nWith MkDocs and mkdocstrings:\n\n```yaml\nplugins:\n- mkdocstrings:\n    handlers:\n      python:\n        options:\n          extensions:\n          - griffe_inherited_docstrings\n```\n\nThe extension will iterate on every class and their members\nto set docstrings from parent classes when they are not already defined.\n\nThe extension accepts a `merge` option, that when set to true\nwill actually merge all parent docstrings in the class hierarchy\nto the child docstring, if any.\n\n```yaml\nplugins:\n- mkdocstrings:\n    handlers:\n      python:\n        options:\n          extensions:\n          - griffe_inherited_docstrings:\n              merge: true\n```\n\n```python\nclass A:\n    def method(self):\n        \"\"\"Method in A.\"\"\"\n\nclass B(A):\n    def method(self):\n        ...\n\nclass C(B):\n    ...\n\nclass D(C):\n    def method(self):\n        \"\"\"Method in D.\"\"\"\n\nclass E(D):\n    def method(self):\n        \"\"\"Method in E.\"\"\"\n```\n\nWith the code above, docstrings will be merged like following:\n\nClass | Method docstring\n----- | ----------------\n`A`   | Method in A.\n`B`   | Method in A.\n`C`   | Method in A.\n`D`   | Method in A.\u003cbr\u003e\u003cbr\u003eMethod in D.\n`E`   | Method in A.\u003cbr\u003e\u003cbr\u003eMethod in D.\u003cbr\u003e\u003cbr\u003eMethod in E.\n\nWARNING: **Limitation**\nThis extension runs once on whole packages. There is no way to toggle merging or simple inheritance for specifc objects.\n\n## Sponsors\n\n\u003c!-- sponsors-start --\u003e\n\u003c!-- sponsors-end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fgriffe-inherited-docstrings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fgriffe-inherited-docstrings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fgriffe-inherited-docstrings/lists"}