# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-mkdocstrings
VERSION=		0.27.0
KEYWORDS=		python
VARIANTS=		v12 v13
SDESC[v12]=		Documentation from sources for MkDocs (3.12)
SDESC[v13]=		Documentation from sources for MkDocs (3.13)
HOMEPAGE=		https://mkdocstrings.github.io
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/cd/10/4c27c3063c2b3681a4b7942f8dbdeb4fa34fecb2c19b594e7345ebf4f86f
DISTFILE[1]=		mkdocstrings-0.27.0-py3-none-any.whl:main
DF_INDEX=		1
SPKGS[v12]=		single
SPKGS[v13]=		single

OPTIONS_AVAILABLE=	PY312 PY313
OPTIONS_STANDARD=	none
VOPTS[v12]=		PY312=ON PY313=OFF
VOPTS[v13]=		PY312=OFF PY313=ON

DISTNAME=		mkdocstrings-0.27.0.dist-info

GENERATED=		yes

[PY312].RUN_DEPENDS_ON=			python-click:single:v12
					python-Jinja2:single:v12
					python-Markdown:single:v12
					python-MarkupSafe:single:v12
					python-mkdocs:single:v12
					python-mkdocs-autorefs:single:v12
					python-platformdirs:single:v12
					python-pymdown-extensions:single:v12
[PY312].USES_ON=			python:v12,wheel

[PY313].RUN_DEPENDS_ON=			python-click:single:v13
					python-Jinja2:single:v13
					python-Markdown:single:v13
					python-MarkupSafe:single:v13
					python-mkdocs:single:v13
					python-mkdocs-autorefs:single:v13
					python-platformdirs:single:v13
					python-pymdown-extensions:single:v13
[PY313].USES_ON=			python:v13,wheel

[FILE:2899:descriptions/desc.single]
# mkdocstrings

[ci]
[documentation]
[pypi version]
[conda version]
[gitter]

Automatic documentation from sources, for [MkDocs].
Come have a chat or ask questions on our [Gitter channel].

---

**[Features]** - **[Installation]** - **[Quick usage]**

![mkdocstrings_gif1]

## Features

- [**Language-agnostic:**]
  just like *MkDocs*, *mkdocstrings* is written in Python but is
language-agnostic.
  It means you can use it with any programming language, as long as there
is a
  [**handler**] for it.
  We currently have [handlers] for the
  [C],
  [Crystal],
  [Python],
  [TypeScript], and
  [VBA] languages,
  as well as for [shell scripts/libraries].
  Maybe you'd like to add another one to the list? :wink:

- [**Multiple themes support:**]
  each handler can offer multiple themes. Currently, we offer the
  :star: [Material theme] :star:
  as well as basic support for the ReadTheDocs and MkDocs themes for the
Python handler.

- [**Cross-references across pages:**]
  *mkdocstrings* makes it possible to reference headings in other Markdown
files with the classic Markdown linking
  syntax: `[identifier][]` or `[title][identifier]` -- and you don't need
to remember which exact page this object was
  on. This works for any heading that's produced by a *mkdocstrings*
language handler, and you can opt to include
  *any* Markdown heading into the global referencing scheme.

    **Note**: in versions prior to 0.15 *all* Markdown headers were
included, but now you need to
    [opt in].

- [**Cross-references across sites:**]
  similarly to [Sphinx's intersphinx extension],
  *mkdocstrings* can reference API items from other libraries, given they
provide an inventory and you load
  that inventory in your MkDocs configuration.

- [**Inline injection in Markdown:**]
  instead of generating Markdown files, *mkdocstrings* allows you to inject
  documentation anywhere in your Markdown contents. The syntax is simple:
`::: identifier` followed by a 4-spaces
  indented YAML block. The identifier and YAML configuration will be passed
to the appropriate handler
  to collect and render documentation.

- [**Global and local configuration:**]
  each handler can be configured globally in `mkdocs.yml`, and locally for
each
  "autodoc" instruction.

- **Reasonable defaults:**
  you should be able to just drop the plugin in your configuration and
enjoy your auto-generated docs.

## Used by

*mkdocstrings* is used by well-known companies, projects and scientific
teams:
[Ansible],
[Apache],
[FastAPI],
[Google],
[Jitsi],
[Microsoft],
[Prefect],
[Pydantic],
[and more...]

## Installation

The `mkdocstrings` package doesn't provide support for any language: it's
just a common base for language handlers.
It means you likely want to install it with one or more official handlers,
using [extras].
For example, to install it with Python support:

```bash
pip install 'mkdocstrings[python]'


[FILE:115:distinfo]
6ceaa7ea830770959b55a16203ac63da24badd71325b96af950e59fd37366332        30658 mkdocstrings-0.27.0-py3-none-any.whl