{"categories":[{"label":"Markup","url":"https://skillfed.io/packages/category/text-processing-markup"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Converts Python docstrings from reStructuredText and Google format to Markdown on the fly, with extensibility via entry points for custom converters.","skillfed_tags":["docstring-conversion","documentation-tooling"],"use_cases":["Normalize docstrings across a codebase from RST to Markdown for consistent documentation rendering.","Generate Markdown documentation from existing Python modules with reStructuredText docstrings.","Integrate into documentation build tools (e.g., Sphinx plugins) to convert docstring formats on the fly.","Support Google-style docstrings in projects that need Markdown output for API documentation.","Build custom docstring processors by extending the converter via entry points for domain-specific formats."],"what_it_does":"docstring-to-markdown is a lightweight converter that transforms Python docstrings written in reStructuredText or Google format into Markdown. It's designed to run on demand, making it useful in documentation pipelines, code analysis tools, or any workflow that needs to normalize docstring formats. The package supports Python 3.7 and later, with tested coverage through Python 3.13.\n\nThe converter works by recognizing the input format and applying format-specific transformations\u2014for example, converting RST math notation like `:math:\\`\\\\sum\\`` to Markdown's dollar-sign syntax `$\\\\sum$`. When the format is unrecognized, it raises UnknownFormatError. The package is designed to be extended: custom converters can be registered via entry points, and built-in converters can be overridden by providing matching entry points.","worth_installing":"Yes, if you need to convert reStructuredText or Google-format docstrings to Markdown. The package is lightweight, has no security vulnerabilities, and integrates well into documentation workflows. The aging maintenance status (469 days since last release) is a minor concern for a stable, narrowly-scoped tool, but the repository remains active. The copyleft license (LGPL-2.1-or-later) is a consideration if you plan to redistribute or embed it in proprietary code."},"id":"docstring-to-markdown","links":{"html":"https://skillfed.io/packages/docstring-to-markdown","md":"https://skillfed.io/packages/docstring-to-markdown.md","pypi":"https://pypi.org/project/docstring-to-markdown/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-05-02","license_spdx":null,"license_treatment":"copyleft","name":"docstring-to-markdown","python_support":"supports_current","summary":"On the fly conversion of Python docstrings to markdown"},"popularity":{"monthly_downloads":1419455,"position":3928,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"0.17"}