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

Updating requirements for myst-parser #1213

Merged
merged 20 commits into from
Feb 14, 2021
Merged

Updating requirements for myst-parser #1213

merged 20 commits into from
Feb 14, 2021

Conversation

choldgraf
Copy link
Contributor

@choldgraf choldgraf commented Feb 12, 2021

Switching the myst parser branch to origin so that the CI can pass fully.

Supercedes #1192


Copying issue description from #1192/#1197:

  • Updates the requirements file to use the myst-parser instead of recommonmark
  • Updates all of the eval_rst blocks to instead use {eval-rst} directives, which are the MyST-equivalent of the same thing
    • This should mean that these docs behave the same was as they did with recommonmark.
    • However, there are likely going to be a few places where the behavior isn't quite the same (e.g., I think recommonmark lets you link directly to headers via [sometext](page#header)). Will need to find these and update them.
  • Updates the index page to use MyST markdown syntax, just to give you an idea of what this change will look like elsewhere as well.

@jpmckinney
Copy link
Member

Aha, I think I need to give you Maintain privileges.

@jpmckinney
Copy link
Member

Also supersedes #1197

@jpmckinney
Copy link
Member

jpmckinney commented Feb 12, 2021

Comment moved to #1190 (comment)

@choldgraf
Copy link
Contributor Author

@jpmckinney shall we add those to-do items to the meta issue here? #1190

Or do you want them addressed before merging this PR? (I think my preference is to merge-and-iterate, so long as there are no bugs or errors being introduced, so that we don't overly complicate each PR).

The other thing we should do is a bit of triage on those issues - which are in-scope for what I'm doing, which are more important than others ,etc.

@jpmckinney
Copy link
Member

@choldgraf Indeed - I've moved the comment to #1190; some of the tasks are notes to myself to cover (e.g. search). I'll review this PR with an aim to getting it merged without including further tasks.

@jpmckinney jpmckinney added this to the Iterative improvements milestone Feb 13, 2021
@jpmckinney jpmckinney merged commit 21383b2 into 1.1-dev Feb 14, 2021
@jpmckinney jpmckinney deleted the myst-parser-switch branch February 14, 2021 06:06
@jpmckinney
Copy link
Member

🎉

@choldgraf
Copy link
Contributor Author

Woohoo! Step 1 🙂

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