Skip to main content

A minimalistic python documentation tool.

Project description

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/

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

mindoc-0.5.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

mindoc-0.5.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file mindoc-0.5.0.tar.gz.

File metadata

  • Download URL: mindoc-0.5.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for mindoc-0.5.0.tar.gz
Algorithm Hash digest
SHA256 006bec326c470b7ac0723920e97e0be1620b400cb0efa9a342c6a1217e3b7621
MD5 22cfed757b2ceba905712cc45ab96131
BLAKE2b-256 18c1db69c086b45eca33a7511d71ce8c2e951e127b792898990d31b4c7f20ba7

See more details on using hashes here.

File details

Details for the file mindoc-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: mindoc-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for mindoc-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c4c02a66b0959c7293192664bc13d988306ff170f6b0b6169b04a2cfa3bf8c8
MD5 e7c9f139e86e19c1cc68ff0888e4ef7b
BLAKE2b-256 10fffa420ad09649b4a4521bfded0c3b1d8f3fa77e431e2c2feaa231cc84ae2a

See more details on using hashes here.

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