Skip to content

Improve the doc formating on RTD #344

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

Closed
mwouts opened this issue Sep 25, 2020 · 2 comments · Fixed by #345
Closed

Improve the doc formating on RTD #344

mwouts opened this issue Sep 25, 2020 · 2 comments · Fixed by #345

Comments

@mwouts
Copy link
Contributor

mwouts commented Sep 25, 2020

Hi,

Thanks for this nice project!

I see that the documentation uses Markdown files, but these files are not properly rendered on RTD.

For instance, this file: https://github.com/jupyter/kernel_gateway/blob/master/docs/source/features.md
image

is rendered on https://jupyter-kernel-gateway.readthedocs.io/en/latest/features.html as
image

In my experience this can be fixed by activating the recommonmark extension in docs\conf.py.

Would you be open to a PR going into that direction?

@kevin-bates
Copy link
Member

Absolutely! Thank you Marc!

@mwouts
Copy link
Contributor Author

mwouts commented Sep 26, 2020

Done! And that is possibly the shortest PR I ever made 😄
Thank you Kevin for you quick answer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants