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

Incompatibility with rST spec: code vs include #4864

Closed
flyx opened this issue Oct 8, 2016 · 4 comments
Closed

Incompatibility with rST spec: code vs include #4864

flyx opened this issue Oct 8, 2016 · 4 comments
Labels
Documentation Generation Related to documentation generation (but not content). Parser

Comments

@flyx
Copy link
Contributor

flyx commented Oct 8, 2016

rST's include directive provides a parameter code for including files that should be parsed as source code which may be highlighted. This is missing in Nim. However, Nim provides a non-standard, undocumented (at least not here) file parameter for code (and the nonstandard code-block directive).

It would be better to implement the specification for include instead of making undocumented extensions elsewhere.

@Araq
Copy link
Member

Araq commented Feb 2, 2017

These extensions have been copied from Sphinx or similar before rST got official support for this feature.

@Araq Araq added the Tools label Feb 2, 2017
@krux02 krux02 added Parser Documentation Generation Related to documentation generation (but not content). and removed Tools labels Oct 29, 2018
@timotheecour
Copy link
Member

I wonder if this kind of non-standard extensions cause some rst files to be incorrectly parsed by github's linguist eg:

@timotheecour
Copy link
Member

I wonder if this kind of non-standard extensions cause some rst files to be incorrectly parsed by github's linguist eg:

I've fixed this in #17092, it now renders fine in github, and was unrelated to use of non-standard extensions.

@Araq
Copy link
Member

Araq commented Aug 27, 2023

We moved to Markdown.

@Araq Araq closed this as completed Aug 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Generation Related to documentation generation (but not content). Parser
Projects
None yet
Development

No branches or pull requests

4 participants