{"id":13472707,"url":"https://github.com/mkdocstrings/mkdocstrings","last_synced_at":"2025-05-14T02:09:49.102Z","repository":{"id":37575783,"uuid":"226936416","full_name":"mkdocstrings/mkdocstrings","owner":"mkdocstrings","description":":blue_book: Automatic documentation from sources, for MkDocs.","archived":false,"fork":false,"pushed_at":"2025-04-01T12:05:34.000Z","size":1127,"stargazers_count":1848,"open_issues_count":60,"forks_count":111,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-11T06:13:01.922Z","etag":null,"topics":["autodoc","docstrings","material-theme","mkdocs","mkdocs-plugin","mkdocstrings","python"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/","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},"funding":{"github":"pawamoy","polar":"pawamoy"}},"created_at":"2019-12-09T18:09:09.000Z","updated_at":"2025-04-10T17:04:12.000Z","dependencies_parsed_at":"2023-02-15T08:31:02.467Z","dependency_job_id":"768814ce-86df-421f-9b64-238bc81d1323","html_url":"https://github.com/mkdocstrings/mkdocstrings","commit_stats":{"total_commits":638,"total_committers":46,"mean_commits":"13.869565217391305","dds":0.2288401253918495,"last_synced_commit":"2f6ddbe379ea8f1eabad1527f2e8e620c3b973d9"},"previous_names":[],"tags_count":95,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fmkdocstrings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fmkdocstrings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fmkdocstrings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fmkdocstrings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/mkdocstrings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254053297,"owners_count":22006717,"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":["autodoc","docstrings","material-theme","mkdocs","mkdocs-plugin","mkdocstrings","python"],"created_at":"2024-07-31T16:00:57.270Z","updated_at":"2025-05-14T02:09:44.091Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","readme":"# mkdocstrings\n\n[![ci](https://github.com/mkdocstrings/mkdocstrings/workflows/ci/badge.svg)](https://github.com/mkdocstrings/mkdocstrings/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocstrings.svg)](https://pypi.org/project/mkdocstrings/)\n[![conda version](https://img.shields.io/conda/vn/conda-forge/mkdocstrings)](https://anaconda.org/conda-forge/mkdocstrings)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#mkdocstrings:gitter.im)\n\nAutomatic documentation from sources, for [MkDocs](https://www.mkdocs.org/).\nCome have a chat or ask questions on our [Gitter channel](https://gitter.im/mkdocstrings/community).\n\n---\n\n**[Features](#features)** - **[Installation](#installation)** - **[Quick usage](#quick-usage)**\n\n![mkdocstrings_gif1](https://user-images.githubusercontent.com/3999221/77157604-fb807480-6aa1-11ea-99e0-d092371d4de0.gif)\n\n## Features\n\n- [**Language-agnostic:**](https://mkdocstrings.github.io/handlers/overview/)\n  just like *MkDocs*, *mkdocstrings* is written in Python but is language-agnostic.\n  It means you can use it with any programming language, as long as there is a\n  [**handler**](https://mkdocstrings.github.io/reference/handlers/base/) for it.\n  We currently have [handlers](https://mkdocstrings.github.io/handlers/overview/) for the\n  [C](https://mkdocstrings.github.io/c/),\n  [Crystal](https://mkdocstrings.github.io/crystal/),\n  [Python](https://mkdocstrings.github.io/python/),\n  [TypeScript](https://mkdocstrings.github.io/typescript/), and\n  [VBA](https://pypi.org/project/mkdocstrings-vba/) languages,\n  as well as for [shell scripts/libraries](https://mkdocstrings.github.io/shell/).\n  Maybe you'd like to add another one to the list? :wink:\n\n- [**Multiple themes support:**](https://mkdocstrings.github.io/theming/)\n  each handler can offer multiple themes. Currently, we offer the\n  :star: [Material theme](https://squidfunk.github.io/mkdocs-material/) :star:\n  as well as basic support for the ReadTheDocs and MkDocs themes for the Python handler.\n\n- [**Cross-references across pages:**](https://mkdocstrings.github.io/usage/#cross-references)\n  *mkdocstrings* makes it possible to reference headings in other Markdown files with the classic Markdown linking\n  syntax: `[identifier][]` or `[title][identifier]` -- and you don't need to remember which exact page this object was\n  on. This works for any heading that's produced by a *mkdocstrings* language handler, and you can opt to include\n  *any* Markdown heading into the global referencing scheme.\n\n    **Note**: in versions prior to 0.15 *all* Markdown headers were included, but now you need to\n    [opt in](https://mkdocstrings.github.io/usage/#cross-references-to-any-markdown-heading).\n\n- [**Cross-references across sites:**](https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories)\n  similarly to [Sphinx's intersphinx extension](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html),\n  *mkdocstrings* can reference API items from other libraries, given they provide an inventory and you load\n  that inventory in your MkDocs configuration.\n\n- [**Inline injection in Markdown:**](https://mkdocstrings.github.io/usage/)\n  instead of generating Markdown files, *mkdocstrings* allows you to inject\n  documentation anywhere in your Markdown contents. The syntax is simple: `::: identifier` followed by a 4-spaces\n  indented YAML block. The identifier and YAML configuration will be passed to the appropriate handler\n  to collect and render documentation.\n\n- [**Global and local configuration:**](https://mkdocstrings.github.io/usage/#global-options)\n  each handler can be configured globally in `mkdocs.yml`, and locally for each\n  \"autodoc\" instruction.\n\n- **Reasonable defaults:**\n  you should be able to just drop the plugin in your configuration and enjoy your auto-generated docs.\n\n## Used by\n\n*mkdocstrings* is used by well-known companies, projects and scientific teams:\n[Ansible](https://molecule.readthedocs.io/configuration/),\n[Apache](https://streampipes.apache.org/docs/docs/python/latest/reference/client/client/),\n[FastAPI](https://fastapi.tiangolo.com/reference/fastapi/),\n[Google](https://docs.kidger.site/jaxtyping/api/runtime-type-checking/),\n[IBM](https://ds4sd.github.io/docling/api_reference/document_converter/),\n[Jitsi](https://jitsi.github.io/jiwer/reference/alignment/),\n[Microsoft](https://microsoft.github.io/presidio/api/analyzer_python/),\n[NVIDIA](https://nvidia.github.io/bionemo-framework/API_reference/bionemo/core/api/),\n[Prefect](https://docs.prefect.io/2.10.12/api-ref/prefect/agent/),\n[Pydantic](https://docs.pydantic.dev/dev-v2/api/main/),\n[Textual](https://textual.textualize.io/api/app/),\n[and more...](https://github.com/mkdocstrings/mkdocstrings/network/dependents)\n\n## Installation\n\nThe `mkdocstrings` package doesn't provide support for any language: it's just a common base for language handlers.\nIt means you likely want to install it with one or more official handlers, using [extras](https://packaging.python.org/en/latest/specifications/dependency-specifiers/#extras).\nFor example, to install it with Python support:\n\n```bash\npip install 'mkdocstrings[python]'\n```\n\nAlternatively, you can directly install the language handlers themselves,\nwhich depend on `mkdocstrings` anyway:\n\n```bash\npip install mkdocstrings-python\n```\n\nThis will give you more control over the accepted range of versions for the handlers themselves.\n\nSee the [official language handlers](https://mkdocstrings.github.io/handlers/overview/).\n\n---\n\nWith `conda`:\n\n```bash\nconda install -c conda-forge mkdocstrings mkdocstrings-python\n```\n\n## Quick usage\n\nIn `mkdocs.yml`:\n\n```yaml\nsite_name: \"My Library\"\n\ntheme:\n  name: \"material\"\n\nplugins:\n- search\n- mkdocstrings\n```\n\nIn one of your markdown files:\n\n```markdown\n# Reference\n\n::: my_library.my_module.my_class\n```\n\nSee the [Usage](https://mkdocstrings.github.io/usage) section of the docs for more examples!\n","funding_links":["https://github.com/sponsors/pawamoy","https://polar.sh/pawamoy"],"categories":["Python","Documentation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fmkdocstrings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fmkdocstrings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fmkdocstrings/lists"}