add markdown support to docs

koaning / scikit-fairness

this repo might get accepted

https://scikit-fairness.netlify.app/

29 stars 9 forks source link

Open koaning opened 4 years ago

koaning commented 4 years ago

and also remove all scikit-lego stuff

JCZuurmond commented 4 years ago

See #11 for removing all scikit-lego stuff

JCZuurmond commented 4 years ago

Where do we want to store the markdown files?

koaning commented 4 years ago

in the docs folder.

i am wondering if we want to use mkdocs of sphinx. i don't want to make this decision on my own.

here's an example of mkdocs using markdown in the docstrings ... https://rasahq.github.io/whatlies/api/transformers/

koaning commented 4 years ago