Skip to main content

A fast and easy way to make beautiful documentation markdown files.

Project description

Docstring-Markdown is a fast and easy way to make beautiful documentation markdown files.

You can find the latest documentation at

Why Docstring-Markdown

It's time to share your awesome new package with the world. And... get ready to spend the next week making your docs. Or, make beautiful docs with Docstring-Markdown in just a few lines of code.


$ pip install docstr-md


First, clone a test file from the Docstring-Markdown repo.

$ curl --output

The example uses sklearn formatted docstrings. Let's convert it to markdown.

from docstr_md.python import PySoup, compile_md
from docstr_md.src_href import Github

src_href = Github('')
soup = PySoup(path='', parser='sklearn', src_href=src_href)
compile_md(soup, compiler='sklearn', outfile='')

You'll now have a file in your current directory. This is what it looks like rendered.


  author = {Dillon Bowen},
  title = {Docstring-Markdown},
  url = {},
  date = {2020-05-15},


Users must cite Docstring-Markdown in any publications which use this software.

Docstring-Markdown is licensed with the MIT License.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docstr-md-0.0.6.tar.gz (10.2 kB view hashes)

Uploaded Source

Built Distribution

docstr_md-0.0.6-py3-none-any.whl (14.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page