Switch to the MyST documentation system

[cjolowicz]

MyST allows you to write Sphinx documentation entirely in markdown.

Here is a breakdown of the files that need to be converted:

The RST files under {{cookiecutter.project_name}}:

• The README
• The Contributor Guide
• The Code of Conduct. Use the original Markdown version provided by the Contributor Covenant.
• The licenses. Should we use the original plain text versions?

The RST files under {{cookiecutter.project_name}}/docs:

• The wrapper files: codeofconduct.rst, contributing.rst, license.rst
• The API reference: reference.rst
• The command-line reference: usage.rst
• The index: index.rst

Converting the Cookiecutter's own documentation is tracked in a separate issue, see #1080.

[cjolowicz]

Docstrings still need to be written in reStructuredText, see executablebooks/MyST-Parser#228.

[cjolowicz]

@cauliyang Are you still planning to work on this?

[cauliyang]

@cjolowicz, Sorry for the late reply, and I am still working on that. Last two weeks, I am busy with my Ph.D. project. I will try my best to finish this switch as soon as possible next week 😃 .

[cjolowicz]

Awesome, no rush :)

I'll be working on converting the files outside the generated project (like the top-level README and the files under docs), see #1080.

[cauliyang]

Cool, you are responsible for lots of work ^^ . do you think which part I should mainly focus on? I will try my best 🚀

[cauliyang]

If I misunderstand you, please correct me.

[cjolowicz]

do you think which part I should mainly focus on?

Let's start with your existing PR, which converts only the README. The PR should be changed so there is no option for RST: The README will always be Markdown. Does that make sense?

We can tackle the rest later.

[cjolowicz]

Updated the issue description with a breakdown of the files that need to converted.

[cauliyang]

Yep, that make sense! I can continue to convert other files under the doc to markdown. If you have any comments please free feel to tell me. It is my pleasure to contribute this project 😎