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

docs: 100% MyST Markdown #1974

Merged
merged 48 commits into from
Jan 4, 2021

Conversation

consideRatio
Copy link
Member

@consideRatio consideRatio commented Jan 4, 2021

With MyST being quite mature in my mind and a rst-to-myst parser available, I felt it was time to transition to it entirely. @choldgraf introduced it to this repo a while back, and for me, the experience has been great overall and I much prefer it over rST.

I'm confident it will be a positive experience overall for this Jupyter project to rely on a Markdown based documentation system rather than rST based documentation system. We truly need contributors to the guide for sustainability, so it's a big deal in my mind to make it easier for them by consistently using MyST markdown.

There is one .rst file that remain, which is updated in #1943.

PR summary

rst-to-myst CLI conversions

  1. pip install rst-to-myst
  2. git mv file.rst file.md
  3. git commit -m "docs: move file.rst to file.md
  4. rst2myst parse -f file.md > file.md_tmp
  5. I did manual inspection of file.md_tmp for issues of which there were quite a few related to indentation etc that I fixed.
  6. mv file.md_tmp file.md
  7. git add file.md
  8. git commit -m "docs: rst2myst on file.md

I submitted notes about the rst2myst CLI to executablebooks/rst-to-myst#11.

Misc changes

  • Moved unreferenced images
    I found quite a few unreferenced images in the _static/images folder, I moved them to a folder indicating they were unreferenced by the docs and can be removed.
  • Fixed minor docs bugs

Related

I opened a discussion about rst/myst conversions before in the team-compass, it is in jupyterhub/team-compass#350.

@consideRatio consideRatio force-pushed the pr/rst-to-markdown branch 2 times, most recently from add68c8 to 2db6d01 Compare January 4, 2021 10:17
@consideRatio consideRatio merged commit 22dc6c7 into jupyterhub:master Jan 4, 2021
consideRatio pushed a commit to jupyterhub/helm-chart that referenced this pull request Jan 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants