gramener / gramex

A visual analytics platform to build data-based web apps with less code.
https://gramener.com/gramex/guide/
Other
142 stars 57 forks source link

Convert docstrings into Markdown and publish API docs #345

Open sanand0 opened 3 years ago

sanand0 commented 3 years ago

Is your feature request related to a problem? Please describe. https://learn.gramener.com/gramex/ documents the Gramex libraries, but is not part of the guide, not well written, and is hard to maintain, partly because it's in ReST not Markdown

Describe the solution you'd like

  1. Move this as an integral part of the guide
  2. Convert docstrings from ReST into Markdown

Additional context

Some notes on how to use Sphinx with Markdown

@bhatsandeep @bkamapantula @jaidevd -- your thoughts please?

bkamapantula commented 3 years ago

+1

happy to contribute