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

Why not Github Markdown? #1

Open
sparrell opened this issue Dec 17, 2020 · 0 comments
Open

Why not Github Markdown? #1

sparrell opened this issue Dec 17, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@sparrell
Copy link

URL(s) with the issue:

Description of the issue:
Apparently sphinx-using-restructured-text has been decided on for creating documentation. Since this is github, is there a reason github markdown is not being used. Note they are very very similar and markdown is supported natively on github so you don't need things like makefiles to create it and webpages will display both raw and formatted text in a more intuitive way to average user. I would propose:

  • using github markdown, or
  • an faq explaining why you (whoever you is) decided to make life harder for the average user (yes it's snarky)

Submitting a pull request?

Are you willing to submit a pull request to solve this issue? (Yes/No): Maybe, Yes if you switch to GFM, no is you decide (thru whatever undocumented-as-yet process decisions are made) to stick with sphinx

@irajeshegde irajeshegde self-assigned this Aug 29, 2023
@irajeshegde irajeshegde added the enhancement New feature or request label Aug 29, 2023
@irajeshegde irajeshegde removed their assignment Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants