ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
205 stars 38 forks source link

Generates HTML instead of markdown #44

Closed ronny-rentner closed 1 year ago

ronny-rentner commented 1 year ago

When I look at the generated code, it contains a lot of HTML without any necessity for it, e. g. my parameters are rendered like this

 - <b>`use_cache`</b> (bool):  If set to `False`, allows re-importing of the same source file even if it was imported before.

which renders to

but it should be

 - **`use_cache`** (bool):  If set to `False`, allows re-importing of the same source file even if it was imported before.

which renders to the same result with no HTML:

After all the point of markdown is that the file renders nicely in a web browser but is at the same time easy and natural to read in an ascii text editor.

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days