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

docs: replace ryd with something less custom #7

Open
ssbarnea opened this issue Jul 19, 2020 · 5 comments
Open

docs: replace ryd with something less custom #7

ssbarnea opened this issue Jul 19, 2020 · 5 comments
Assignees
Labels
docs This issue/PR relates to or includes documentation. help wanted Extra attention is needed

Comments

@ssbarnea
Copy link
Member

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.

@smurfix
Copy link
Collaborator

smurfix commented Jul 19, 2020

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.

@ssbarnea
Copy link
Member Author

ssbarnea commented Sep 4, 2020

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

@jwilson8767
Copy link
Collaborator

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
Copy link
Collaborator

@ssbarnea Can you add me to the RTD?

@ssbarnea
Copy link
Member Author

@jwilson8767 done

@ssbarnea ssbarnea added the help wanted Extra attention is needed label Nov 15, 2020
@ssbarnea ssbarnea pinned this issue Nov 15, 2020
@gdubicki gdubicki added the docs This issue/PR relates to or includes documentation. label Dec 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue/PR relates to or includes documentation. help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants