A fast and easy way to make beautiful documentation markdown files.
Project description
Docstring-Markdown
Docstring-Markdown is a fast and easy way to make beautiful documentation markdown files.
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
soup = PySoup(path='test.py', parser='sklearn')
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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cde9cd81e0f47dbe82081b5f0f1aa433e50cbe85406fe879ee0e49bb82813af7 |
|
MD5 | 4c374c3d4e341d66971fd933221470d0 |
|
BLAKE2b-256 | 3b4da37e991ac94af7a9fbacb1a991e8cb4c90a8c662c58eac3edc93bd18344f |