skrub icon indicating copy to clipboard operation
skrub copied to clipboard

DOC - Switch from using rst to markdown in docs

Open rcap107 opened this issue 3 months ago • 1 comments

Using RST makes updating the documentation more complicated than needed in a lot of cases. I think we should move from RST to Markdown once the documentation is in a "relatively stable" shape.

rcap107 avatar Sep 22 '25 11:09 rcap107

Listing here some resources:

  • https://docsforadobe.dev/updating-legacy-docs/converting-rst-to-md/
  • https://docs.readthedocs.com/platform/stable/guides/migrate-rest-myst.html
  • https://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-instead-of-rest
  • https://www.sphinx-doc.org/en/master/usage/markdown.html

rcap107 avatar Sep 24 '25 19:09 rcap107