Skip to content

switch to the recommend myst sphinx module plus fixes #3961

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 13, 2024
Merged

switch to the recommend myst sphinx module plus fixes #3961

merged 1 commit into from
Jun 13, 2024

Conversation

coreyoconnor
Copy link
Contributor

fixes were applied to:

  • cross reference links
  • formatting
  • figures
  • removal of unnecessary single quotes
  • Plus a bunch of whitespace removal my editor insisted on. Sorry.

@coreyoconnor
switch to the recommend myst sphinx module plus fixes
23f1442 
fixes were applied to:

- cross reference links
- formatting
- figures
- removal of unnecessary single quotes
- Plus a bunch of whitespace removal my editor insisted on. Sorry.
@WojciechMazur WojciechMazur merged commit 3cf4e9a into scala-native:main Jun 13, 2024
@LeeTibbert
Copy link
Contributor

Corey,

For those following along at home (or in the future), recommended by whom?
I am not disputing the change, just trying to establish a trail of rationale for "How did this come to be?",
especially when the syntax is different than prior art.

@coreyoconnor
Copy link
Contributor Author

Corey,

For those following along at home (or in the future), recommended by whom? I am not disputing the change, just trying to establish a trail of rationale for "How did this come to be?", especially when the syntax is different than prior art.

Fair question. The original parser was recommonmark: https://github.com/readthedocs/recommonmark

Which is an archived repo with this note: Warning: recommonmark is now deprecated. We recommend using [MyST](https://github.com/executablebooks/MyST-Parser) for a docutils bridge going forward.

@LeeTibbert
Copy link
Contributor

Thank you for the answer/history & for this PR.

The posted sign is pretty clear and authoritative. Puts that concern to rest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@WojciechMazur WojciechMazur WojciechMazur approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@coreyoconnor @LeeTibbert @WojciechMazur