Metadata-Version: 2.1
Name: tomarkdown
Version: 0.0.1
Summary: support tool to generate MkDocs compatible markdown from python scripts
Home-page: https://gitlab.com/berlinade/tomarkdown
Author: codima
License: GPLv3
Project-URL: doc, https://berlinade.gitlab.io/tomarkdown/
Platform: unix
Platform: linux
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE

# tomarkdown

## author information
[codima](https://www.youtube.com/channel/UCwnthITQqkWgaHnz82U7WsA) (coding-mathmatics) on youtube & ...

## Usage

... *under construction*

but in short: **look at** demo1.py as well as my_script.py in the "demo" folder. 
The demo1.py scripts imports and initiates the tomarkdown package to generate:

  - my_script.md
  - my_script.TopLevel.md
  - my_script.TopLevel.MidLevel.md
  - my_script.a_class_generator

for the documentation of my_script.py.
Finally the mkdocs.yml has been adjusted by hand to include the generated markdown scripts and then Mkdocs does its thing.
You can see the results for yourself here: [https://berlinade.gitlab.io/tomarkdown](https://berlinade.gitlab.io/tomarkdown)

## docs

... *under construction*

[https://berlinade.gitlab.io/tomarkdown/](https://berlinade.gitlab.io/tomarkdown/)

#### informal info on license (english)
This repository is licensed under GPL-V3 (see LICENSE). You can refer to the author of this package as codima & ... .
