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

rst: add github-specific comment to visit readthedocs #225

Open
SteVwonder opened this issue Feb 6, 2020 · 0 comments
Open

rst: add github-specific comment to visit readthedocs #225

SteVwonder opened this issue Feb 6, 2020 · 0 comments

Comments

@SteVwonder
Copy link
Member

Github's markup render maintainers have said they will not support Sphinx-specific extensions to ReST, including :doc: and :toctree:.

Reading the comments in the markup source code, GitHub suggests that we add a comment at the top of the file saying the user should visit readTheDocs for the nicely rendered file. Poking at their renderer's source code, it looks like if you start a comment with github display, then github will show the comment in the render. Source.

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

No branches or pull requests

1 participant