Skip to content

Convert documentation source files from ReStructuredText to Markdown #2928

@seisman

Description

@seisman

Currently, some documentations are written in Markdown while some are in ReStructuredText. I think it's better to use a consistent format so that new contributors won't be confused.

Here are the .rst files in the repository:

$ find . -name '*.rst'
./README.rst
./doc/install.rst
./doc/overview.rst
./doc/index.rst
./doc/api/index.rst
./doc/_templates/autosummary/module.rst
./doc/_templates/autosummary/class.rst
./doc/_templates/autosummary/exception.rst
./doc/_templates/autosummary/method.rst
./doc/_templates/autosummary/base.rst
./doc/_templates/autosummary/function.rst

I think at least the following three files should be converted to markdown:

Comments?

Metadata

Metadata

Assignees

No one assigned

    Labels

    maintenanceBoring but important stuff for the core devs

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions