Skip to content

Convert markdown documentation to reStructuredText #3663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cgeorgii opened this issue Jun 15, 2023 · 1 comment
Open

Convert markdown documentation to reStructuredText #3663

cgeorgii opened this issue Jun 15, 2023 · 1 comment
Labels

Comments

@cgeorgii
Copy link
Contributor

Motivation

Markdown is great but lacks some interesting features:

  • Importing source code with literalInclude
  • Admonition boxes
  • etc.

Proposed solution

Ideally all markdown files in the docs/ directory could be converted to reStructuredText.

Additional context

This issue originated from a comment.

@cgeorgii cgeorgii changed the title Convert markdown documentation to rst Convert markdown documentation to reStructuredText Jun 15, 2023
@michaelpj
Copy link
Collaborator

I don't think we should do this wholesale: the markdown files are easier for people to contribute to. But using RST where it provides useful additional power is sensible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants