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 https://dsbowen.github.io/docstr-md.
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.
Installation
$ pip install docstr-md
Quickstart
First, clone a test file from the Docstring-Markdown repo.
$ curl https://raw.githubusercontent.com/dsbowen/docstr-md/master/test.py --output test.py
The example test.py
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('https://github.com/dsbowen/docstr-md/blob/master')
soup = PySoup(path='test.py', parser='sklearn', src_href=src_href)
compile_md(soup, compiler='sklearn', outfile='test.md')
You'll now have a test.md
file in your current directory. This is what it looks like rendered.
Citation
@software{bowen2020docstr-md,
author = {Dillon Bowen},
title = {Docstring-Markdown},
url = {https://dsbowen.github.io/docstr-md/},
date = {2020-05-15},
}
License
Users must cite Docstring-Markdown in any publications which use this software.
Docstring-Markdown is licensed with the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docstr_md-0.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 625473c96c80c971100218c30b2371062f8db38b727e7a5351802fe0f729b7fb |
|
MD5 | 13f4c0b8354fb9ccd0af3cbf3193c941 |
|
BLAKE2b-256 | b7ab3dd67132cf84ac92cb1a151d4f4eb2c75f715a5b30b2b398e20977346a43 |