Skip to content
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

Guidance on rst vs md for documentation #947

Open
2 tasks done
Tracked by #944
zklaus opened this issue Aug 6, 2024 · 0 comments
Open
2 tasks done
Tracked by #944

Guidance on rst vs md for documentation #947

zklaus opened this issue Aug 6, 2024 · 0 comments
Labels
type::documentation request for improved documentation

Comments

@zklaus
Copy link

zklaus commented Aug 6, 2024

Checklist

  • I added a descriptive title
  • I searched open reports and couldn't find a duplicate

What happened?

By virtue of the MyST parser extension, already now markdown is supported as an alternative format for the documentation next to the traditional restructured text. At the moment, this is mostly used for deep dives and a few other documents.

It might be a good idea to clarify the use in the contribution guidelines, either by saying both are fine, or to move forward with only one in the future (as a side note, for documents, automatic conversion is available, so switching over entirely is also an option).

Both can equally be used for docstrings, iirc.

It is also possible to identify clear areas where one should be used over the other. For example, we may decide to write docstrings in rst, but narrative documentation in md.

Additional Context

No response

@zklaus zklaus added the type::documentation request for improved documentation label Aug 6, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in 🧭 Planning Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::documentation request for improved documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant