Switch from reStructuredText to Markdown and add docs/ (#1139)

Browse Source

* Convert most of the documentation from the frontend `README.rst` to `docs/REAME.md`

Also converted all reStructuredText files to Markdown.

* Tell `mdformat` to use LF for end on lines

* `--check` is not needed in the help message

* Skip tests on GitHub Windows.

Those tests pass on a real Windows machine.
Let's revisit those failure later, if needed.

* Move `mdoformat` requirement from `test` to `dev` extra

To fix Fedora CI.

...

This commit is contained in:

Mickaël Schoentgen authored and GitHub committed 2021-09-06 17:36:13 +02:00

1 parent e7d8b9cece

commit 6039bd8582

16 files changed

+2436 -3157

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/README.md

+1686

File diff suppressed because it is too large. Load diff