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.

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

Convert all files from reST to MyST #515

Merged
merged 45 commits into from
Sep 9, 2021
Merged

Convert all files from reST to MyST #515

merged 45 commits into from
Sep 9, 2021

Conversation

stevepiercy
Copy link
Contributor

No description provided.

@stevepiercy
Copy link
Contributor Author

I'm going to do everything in this step, except delete the rst2myst directory. I want to have a record of the process for my future self.

@stevepiercy stevepiercy marked this pull request as draft September 2, 2021 19:02
@stevepiercy
Copy link
Contributor Author

One thing that bit me was that rst2myst enables colon_fence by default. Specify --no-colon-fence to override the default. I don't know why they did that.

There is a total of 351 files to convert.

@stevepiercy
Update good output of dryrun
551cd61
@stevepiercy
Result of rst2myst convert command
9416b8a
@stevepiercy
Remove 351 .rst files
430d46f
@stevepiercy
Update .md files to validate and build successfully
1cee91a 
- Change console to shell as appropriate
- Fix sidebar syntax, where content starts on a new line and nesting should use backticks instead of tildes
- All label word separators got converted from _ to -. Fine. Have it your way rst2myst. One fewer keystroke in the future.
- Comment out `...` to avoid invalid syntax for highlighting by Pygments in Sphinx. Authors should fix this, NOT IT! Else we should use `text` as the lexer.
- Fix bibliography information. This might need to be adjusted for the meta information for SEO. @ksuess might know.
@stevepiercy stevepiercy marked this pull request as ready for review September 3, 2021 01:13
@stevepiercy
Copy link
Contributor Author

Please take a look at this specific commit and its message. This might save y'all some pain and suffering when you edit MyST.

@stevepiercy
Copy link
Contributor Author

Here are the remaining steps to perform, after this PR is merged.

  • In conf.py remove rst2myst/training/** from exclude_patterns.

  • Uninstall rst-to-myst.

    pip uninstall "rst-to-myst[sphinx]"

  • Delete the directory rst2myst.

@stevepiercy stevepiercy mentioned this pull request Sep 3, 2021
Closed
37 tasks
@stevepiercy stevepiercy changed the title Use backtick syntax, add --no-colon-fences flag to rst2myst command Convert all the files from from reST to MyST Sep 3, 2021
@stevepiercy stevepiercy changed the title Convert all the files from from reST to MyST Convert all files from reST to MyST Sep 3, 2021
@stevepiercy stevepiercy mentioned this pull request Sep 4, 2021
Closed
4 tasks
ksuess
ksuess approved these changes Sep 4, 2021
View reviewed changes
Copy link
Member

@ksuess ksuess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine for me. I will take this as a base for applying the theme, adding some theme specific fixes. It would be good not to add further changes to this.

ksuess added 11 commits September 5, 2021 20:25
@stevepiercy stevepiercy marked this pull request as draft September 6, 2021 18:36
@stevepiercy
Copy link
Contributor Author

DO NOT MERGE!

Awaiting other PRs to merge to this PR, before merging this PR to master.

See also #506 for complete checklist.

@stevepiercy stevepiercy marked this pull request as ready for review September 9, 2021 17:08
@pbauer pbauer merged commit bc8b146 into master Sep 9, 2021
@pbauer pbauer deleted the myst-convert-all branch October 11, 2021 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ksuess ksuess ksuess approved these changes

@pbauer pbauer Awaiting requested review from pbauer

@spereverde spereverde Awaiting requested review from spereverde

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

Successfully merging this pull request may close these issues.
3 participants
@stevepiercy @ksuess @pbauer