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

Add doctype: RST|Markdown|RstMarkdown pragma #20252

Merged
merged 6 commits into from
Aug 23, 2022

Conversation

a-mr
Copy link
Contributor

@a-mr a-mr commented Aug 20, 2022

Implements nim-lang/RFCs#68 , see also discussion in #17987

doctype sets markup language on a module level.

The permitted values:

  • markdown, which is default. It still contains nearly all of the RST supported but it is assumed that in time we will give up most or all RST features in this mode
  • rst, without any Markdown extensions
  • RstMarkdown — for compatibility with Nim 1.x. It's basically RST with those Markdown features enabled that don't conflict with RST.

Implements nim-lang/RFCs#68 ,
see also discussion in nim-lang#17987

The permitted values:
* `markdown`, which is default. It still contains nearly all of
  the RST supported but it is assumed that in time we will give up
  most or all RST features in this mode
* `rst`, without any extensions
* `RstMarkdown` — compatibility with Nim 1.x. It's basically RST
  with those Markdown features enabled that don't conflict with RST.
compiler/docgen.nim Outdated Show resolved Hide resolved
compiler/docgen.nim Outdated Show resolved Hide resolved
compiler/docgen.nim Outdated Show resolved Hide resolved
compiler/pragmas.nim Outdated Show resolved Hide resolved
a-mr and others added 2 commits August 22, 2022 21:05
Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
@Varriount
Copy link
Contributor

Since the RFC has been merged, I'm merging this.

@Varriount Varriount merged commit 1465615 into nim-lang:devel Aug 23, 2022
@github-actions
Copy link
Contributor

Thanks for your hard work on this PR!
The lines below are statistics of the Nim compiler built from 1465615

Hint: mm: orc; threads: on; opt: speed; options: -d:release
163624 lines; 12.478s; 841.328MiB peakmem

capocasa pushed a commit to capocasa/Nim that referenced this pull request Mar 31, 2023
* Add `doctype: RST|Markdown|RstMarkdown` pragma

Implements nim-lang/RFCs#68 ,
see also discussion in nim-lang#17987

The permitted values:
* `markdown`, which is default. It still contains nearly all of
  the RST supported but it is assumed that in time we will give up
  most or all RST features in this mode
* `rst`, without any extensions
* `RstMarkdown` — compatibility with Nim 1.x. It's basically RST
  with those Markdown features enabled that don't conflict with RST.

* Apply suggestions from code review

Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>

* Additional fix in spirit of review

* Fix test after nim-lang#20188

Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
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 this pull request may close these issues.

2 participants