Lengthy one-page API docs

scienxlab / redflag

Safety net for machine learning pipelines. Plays nice with sklearn and pandas.

https://scienxlab.org/redflag

Apache License 2.0

21 stars 6 forks source link

Lengthy one-page API docs #93

Closed jsheunis closed 9 months ago

jsheunis commented 9 months ago

The Python API documentation is quite lengthy for a single page (https://scienxlab.org/redflag/redflag.html#), and requires lots of scrolling / searching to find specific content. I suggest splitting it up into one page per module.

Ping https://github.com/openjournals/joss-reviews/issues/6065

kwinkunks commented 9 months ago

Great idea, I need to learn more about the apidoc plugin.

Fixed in 046d75812abc87b794e320067aa44a07006bb941