Skip to content

Simple package to generate Code Reference from source in Markdown

License

Notifications You must be signed in to change notification settings

eipanteleev-lm/pymdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Workflow Badge

pymdocs

A simple package to generate Code Reference from source in Markdown

Example: Code Reference.md

Installation

python setup.py install

Usage

python -m pymdocs ./pymdocs "./docs/Code Reference.md"

Features

  • Using only standard library features
  • Generating source links to lines of code
  • Markdown formatting
  • Google Style docstrings parsing
  • Numpy docstrings parsing

About

Simple package to generate Code Reference from source in Markdown

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages