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.

Sign up for GitHub

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

Jump to bottom

[feature-request] Support for restructured text #72

Open
purhan opened this issue Feb 11, 2021 · 2 comments
Open

[feature-request] Support for restructured text #72

purhan opened this issue Feb 11, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@purhan
Copy link

purhan commented Feb 11, 2021

Many projects on github use RestructuredText (.rst) for their README.
Example
Is there a desire to add support for it?
@xcv58 xcv58 added the enhancement New feature or request label Feb 11, 2021
@Siddhant-K-code
Copy link
Collaborator

What are the benefits of using .rst in README?

@purhan
Copy link
Author

purhan commented Feb 21, 2021

What are the benefits of using .rst in README?

@Siddhant-K-code It's generally preferred to use it for making API related docs. It has inbuilt features like Table of contents, symbolic mathematics, etc. Popular tools like sphinx use it for such reasons I believe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@xcv58 @purhan @Siddhant-K-code