joaquimesteves/docs-to-md

Ever wanted to automatically generate markdown from pydocs? Are all of the other tools lacking in simplicity? Well have I got the answer for you

docs-to-md's Issues

Proposal: Add class methods to class header

Currently, classes are denoted with <h2> and functions with <h3>

It would perhaps be interesting to slightly separate class methods from normal function definitions.

Include global variables

Currently, the program doesn't even consider global variables.

I did it, so that we'd not bother with the den of madness that is associating docstrings to
specific variables.

Here's an example:

# am I a comment, or related to the var bellow?
foo = ...
"""What about me? Do I belong to foo or bar? Or am I unrelated?
bar = ...

The solution I'm currently considering, is to look for the nearest docstring (top to bottom) of a given
variable if, and only if, it's written in caps lock.

Further suggestions are welcome