search

ioos / ioos_qc

:ballot_box_with_check: :ocean: IOOS QARTOD and other Quality Control tests implemented in Python
https://ioos.github.io/ioos_qc/
Apache License 2.0
46 stars 28 forks source link

Docs should use markdown instead of ReStructuredText #20

Closed jessicaaustin closed 5 years ago

jessicaaustin commented 5 years ago

https://www.sphinx-doc.org/en/master/usage/markdown.html

See instructions on how to build docs locally here: https://ioos.github.io/ioos_qc/installation.html#development-and-testing

PRs accepted!

kwilcox commented 5 years ago

Markdown is great for super simple formatting but anything a tad more complicated (tables, intra-linking, anchors, re-usable varaibles, etc.) isn't possible AFAIK.

Level 1 - Documentarist using Markdown ... a few hours... Level 10 - Super Archivist using rST

It's worth every second.

jessicaaustin commented 5 years ago

If people want to submit doc PRs, they are welcome to do so in Markdown or whatever is easiest, and we can convert to rST.