Skip to content

Commit

Permalink
Convert README from RST to MD (fix PyPI packaging)
Browse files Browse the repository at this point in the history
The Readme was not compliant with PyPI renderer. Instead of using
reStructuredText, it was converted to GitHub Flavored Markdown (preserve
centered elements, notably).

To make it compatible with the HTML documentation generated by Sphinx,
we rely on the "myst_parser" extension. We probably should consider
migrating the whole documentation to Markdown.
There is also MkDocs, but it seems more intrusive in regards to the
existing Sphinx / ReadTheDocs configuration.
  • Loading branch information
Delgan committed Dec 3, 2024
1 parent cb3314a commit ef12cbb
Show file tree
Hide file tree
Showing 6 changed files with 421 additions and 527 deletions.
Loading

0 comments on commit ef12cbb

Please sign in to comment.