Open evanroyrees opened 2 years ago
So would converting still allow integration with readthedocs.org
?
Yes, this is mentioned in readthedocs. They have put together a guide to do just this
I don't think converting to markdown is the best way to do this. I successfully converted to markdown, but it broke autodoc, which is hard-coded for rst. This suggests a workaround, but I think I found a better solution: https://myst-parser.readthedocs.io/en/stable/faq/index.html#howto-autodoc
There is a sphinx extension called sphinx-copybutton
.
I added it to my docker image and the .conf file and it appears to be working, which solved the problems I mentioned to Sidd last week. https://stackoverflow.com/questions/39187220/how-to-add-a-copy-button-in-the-code-blocks-for-rst-read-the-docs
Next, getting sphinx-gallery working and to make images/animations of it running.
Completed with pull request #293
I think there may be tools out there to perform this automagically?
readthedocs on migrating from rst to md 👀
rst2myst convert 👀
Could also just continue on with current docs, but use
md
instead ofrst
by adding a markdown parser extension - sphinx markdown extensionpandoc - gist for rst2md using pandoc