{"library":"mkdocstrings-python-legacy","title":"mkdocstrings-python-legacy","description":"mkdocstrings-python-legacy is a Python handler for the mkdocstrings documentation generator. It facilitates the automatic collection of documentation from Python source code, relying on `pytkdocs` for data extraction. The handler supports popular docstring styles like Google, Numpydoc, and reStructuredText. While actively maintained, receiving updates as recently as May 2025, it is considered a legacy component, and users are strongly advised to migrate to the newer `mkdocstrings-python` handler, which offers improved functionality based on Griffe.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install mkdocstrings-python-legacy","pip install 'mkdocstrings[python-legacy]'"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# mkdocs.yml\nplugins:\n  - mkdocstrings:\n      handlers:\n        python:\n          paths: [src] # Adjust to your source code directory\n          options:\n            docstring_style: google # or numpy, restructured-text\n            members: !docstrings_replace # Example: show only documented members\n\n# docs/index.md\n# ::: my_package.my_module","lang":"yaml","description":"To use mkdocstrings-python-legacy, first ensure it's installed. Then, configure your `mkdocs.yml` file to include `mkdocstrings` in the plugins section and specify the `python` handler within `mkdocstrings.handlers`. You'll need to define `paths` to indicate where your Python source code is located. Once configured, you can inject documentation into your Markdown files using the `:::` syntax, followed by the Python object's dotted path.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}