ruyaml icon indicating copy to clipboard operation
ruyaml copied to clipboard

docs: replace ryd with something less custom

Open ssbarnea opened this issue 5 years ago • 5 comments

Docs should be using standard RST or MD (recently added to Sphinx) instead of "ryd". This should help a little bit with the "NIH" approach.

ssbarnea avatar Jul 19 '20 16:07 ssbarnea

I'd just run ryd2rst on them. These days it's certainly possible to extract the Python code from Sphinx, just mark the code blocks as Python, no need to run a nonstandard tool.

smurfix avatar Jul 19 '20 19:07 smurfix

Can you please make a PR to address the doc building?

ssbarnea avatar Sep 04 '20 13:09 ssbarnea

I'm working on this over on dev-docs. I got the initial conversion to RST done...but there is a long way to go to make these docs really useful.

jwilson8767 avatar Oct 13 '20 04:10 jwilson8767

@ssbarnea Can you add me to the RTD?

jwilson8767 avatar Oct 13 '20 04:10 jwilson8767

@jwilson8767 done

ssbarnea avatar Oct 13 '20 11:10 ssbarnea