Move current docs to myst #2886
Description
Move any sections of the docs to myst using rst-myst command line tool.
- Make the PR from stable
- Install rst2myst with uvx since its requirements are not up to date so it will downgrade your sphinx if you install it in the project environment.
- Use to convert 1 file (for example contrib.rst)
- Fix typos.
- Make PR for that 1 file. If you are planing on helping out will multiple sections, then submit 1 or 2, and I will review them and then you can do more. Because the rst2myst does make mistakes, the reviewer(probably me) needs to click on every link and check carefully line by line.
Just add a comment to what section you are working on.
An unfortunate downside is that the git blame will be reset for the docs files.
The index.rst file needs to be the last file converted since I cannot figure out to have rst files and a md file as the index. See myst docs for how to use myst with sphinx roles. We have a custom roles that will need eval-rst. Check other docs already created for examples and click-extra docs for how the roles work.