carpentries / handbook-beta

Beta version of The Carpentries Handbook.
https://carpentries-beta-handbook-preview.netlify.app/
1 stars 2 forks source link

Consider using MyST instead of reST file format #105

Open dpshelio opened 1 year ago

dpshelio commented 1 year ago

Years ago I suggested migrating to reST (https://github.com/carpentries/docs.carpentries.org/issues/506), and now that we are doing it... I'm proposing to consider using MyST instead, as @astrojuanlu recommended in that original issue.

For the little bit I've seen MyST, it seems great, it will work with sphinx seamlessly and the format is very similar to the one for the lessons used with sandpaper. Also, if everything is using the same format, the translations could also happen at that level. (I haven't explored yet the internasiolasation integration, but if all the files are using the same format I believe the process will be easier than how it was in the previous handbook).

As @juanlu also pointed out in the previous issue, there are tools to convert rst-to-myst that could convert the whole thing at once.