Documentation is in JSDOC format

HuFlungDu / pylibmeshctrl

Libmeshctrl implementation in python

MIT License

1 stars 1 forks source link

Documentation is in JSDOC format #1

Open HuFlungDu opened 3 weeks ago

HuFlungDu commented 3 weeks ago

Need to swap documentation into a python style, and probably generate a readthedocs

DaanSelen commented 2 weeks ago

JSDOC over MarkDown format?

HuFlungDu commented 2 weeks ago

I copied the doc from libmeshctrl, which would output markdown from jsdoc. Looking like I'm going to switch to sphinx with Google style strings for this one, I have a local branch with it started, just need to port the strings.