Skip to content
This repository was archived by the owner on Jan 25, 2024. It is now read-only.

minchulkim87/mindoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mindoc.py

A minimalistic python and SQL documentation tool.

This program converts .py and .sql files into .html documentation files with minimal work on the developer's part.

(You can also use it to conver .md files to .html files in the same style if you wish)

The purpose is to minimise the documentation burden.

Simply write the code as if you would a markdown file with the documentation parts as comment blocks.

This tool also helps automatically generate a table of contents and cross-referencing.

mindoc also supports basic diagramming with markdown-like syntax.

Please see the documentation on GitHub to see how to install and use mindoc.

https://minchulkim87.github.io/mindoc/

About

A minimalistic python documentation module

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages