{"id":15017472,"url":"https://github.com/mkdocstrings/python","last_synced_at":"2026-02-09T17:03:00.665Z","repository":{"id":40771235,"uuid":"422878404","full_name":"mkdocstrings/python","owner":"mkdocstrings","description":"A Python handler for mkdocstrings.","archived":false,"fork":false,"pushed_at":"2025-11-27T16:49:40.000Z","size":5947,"stargazers_count":258,"open_issues_count":43,"forks_count":51,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-11-30T09:10:36.944Z","etag":null,"topics":["autodoc","documentation","mkdocs","mkdocstrings","mkdocstrings-handler","python","python-documentation"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/python","language":"HTML","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":"2021-10-30T12:44:24.000Z","updated_at":"2025-11-27T17:56:58.000Z","dependencies_parsed_at":"2023-02-12T11:48:11.269Z","dependency_job_id":"9b3b236c-f280-48d3-a837-ee65b51f7e9d","html_url":"https://github.com/mkdocstrings/python","commit_stats":{"total_commits":332,"total_committers":19,"mean_commits":"17.473684210526315","dds":0.2530120481927711,"last_synced_commit":"6dafa9ac307fb476ea4b2a17190718ca059c9811"},"previous_names":[],"tags_count":96,"template":false,"template_full_name":null,"purl":"pkg:github/mkdocstrings/python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fpython/sbom","scorecard":{"id":49057,"data":{"date":"2025-08-04","repo":{"name":"github.com/mkdocstrings/python","commit":"e82c24f17513fba4cff22e90f0a82c00a01a077d"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":4.5,"checks":[{"name":"Maintained","score":10,"reason":"19 commit(s) and 14 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:5","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":1,"reason":"Found 5/30 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:116: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:122: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:140: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocstrings/python/release.yml/main?enable=pin","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   5 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: ISC License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 7 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-14T23:21:38.589Z","repository_id":40771235,"created_at":"2025-08-14T23:21:38.589Z","updated_at":"2025-08-14T23:21:38.589Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29273139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T13:47:44.167Z","status":"ssl_error","status_checked_at":"2026-02-09T13:47:43.721Z","response_time":56,"last_error":"SSL_read: 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":["autodoc","documentation","mkdocs","mkdocstrings","mkdocstrings-handler","python","python-documentation"],"created_at":"2024-09-24T19:50:31.547Z","updated_at":"2026-02-09T17:02:56.576Z","avatar_url":"https://github.com/mkdocstrings.png","language":"HTML","readme":"\u003ch1 align=\"center\"\u003emkdocstrings-python\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eA Python handler for \u003ca href=\"https://github.com/mkdocstrings/mkdocstrings\"\u003e\u003ci\u003emkdocstrings\u003c/i\u003e\u003c/a\u003e.\u003c/p\u003e\n\n[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)\n\n---\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"logo.png\"\u003e\u003c/p\u003e\n\nThe Python handler uses [Griffe](https://mkdocstrings.github.io/griffe)\nto collect documentation from Python source code.\nThe word \"griffe\" can sometimes be used instead of \"signature\" in French.\nGriffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information.\nIt is also able to execute the code (by importing it) and introspect objects in memory\nwhen source code is not available. Finally, it can parse docstrings following different styles.\n\n## Installation\n\nYou can install this handler as a *mkdocstrings* extra:\n\n```toml title=\"pyproject.toml\"\n# PEP 621 dependencies declaration\n# adapt to your dependencies manager\n[project]\ndependencies = [\n    \"mkdocstrings[python]\u003e=0.18\",\n]\n```\n\nYou can also explicitly depend on the handler:\n\n```toml title=\"pyproject.toml\"\n# PEP 621 dependencies declaration\n# adapt to your dependencies manager\n[project]\ndependencies = [\n    \"mkdocstrings-python\",\n]\n```\n\n## Preview\n\n\u003c!-- TODO: update the GIF with a more recent screen capture. Maybe use mp4 instead --\u003e\n![mkdocstrings_python_gif](https://user-images.githubusercontent.com/3999221/77157838-7184db80-6aa2-11ea-9f9a-fe77405202de.gif)\n\n## Features\n\n- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to\n  [Griffe](https://github.com/mkdocstrings/griffe).\n\n- **Support for type annotations:** Griffe collects your type annotations and *mkdocstrings* uses them\n  to display parameter types or return types. It is even able to automatically add cross-references\n  to other objects from your API, from the standard library or third-party libraries!\n  See [how to load inventories](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories) to enable it.\n\n- **Recursive documentation of Python objects:** just use the module dotted-path as an identifier, and you get the full\n  module docs. You don't need to inject documentation for each class, function, etc.\n\n- **Support for documented attributes:** attributes (variables) followed by a docstring (triple-quoted string) will\n  be recognized by Griffe in modules, classes and even in `__init__` methods.\n\n- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style,\n  and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support.\n\n- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed\n  to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent.\n  *We do not support nested admonitions in docstrings!*\n\n- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table\n  of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability,\n  you can reference other objects within your docstrings, with the classic Markdown syntax:\n  `[this object][package.module.object]` or directly with `[package.module.object][]`\n\n- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code\n  of the Python object.\n","funding_links":["https://github.com/sponsors/pawamoy","https://polar.sh/pawamoy"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fpython","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fpython","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fpython/lists"}