Skip to content

Why not Github Markdown? #1

@sparrell

Description

@sparrell

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions