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

Move documentation to MyST #179

Closed
paw-lu opened this issue Sep 1, 2021 · 5 comments · Fixed by #384
Closed

Move documentation to MyST #179

paw-lu opened this issue Sep 1, 2021 · 5 comments · Fixed by #384
Labels
documentation Improvements or additions to documentation
Milestone
Beta release

Comments

@paw-lu
Copy link
Owner

paw-lu commented Sep 1, 2021

Investigate MyST as a rst alternative.
@paw-lu paw-lu added the documentation Improvements or additions to documentation label Sep 1, 2021
@paw-lu
Copy link
Owner Author

paw-lu commented Sep 1, 2021

Backport to cookie cutter template

@paw-lu
Copy link
Owner Author

paw-lu commented Sep 3, 2021 •
edited
Loading

Good migration tools listed in this tweet.

@paw-lu paw-lu added this to the 1.0.0 milestone Dec 14, 2021
@paw-lu
Copy link
Owner Author

paw-lu commented Jan 4, 2022

executablebooks/rst-to-myst

@paw-lu
Copy link
Owner Author

paw-lu commented Jan 4, 2022

Docstrings need to be in RST still though, see executablebooks/MyST-Parser#228

@paw-lu
Copy link
Owner Author

paw-lu commented Jan 4, 2022

cjolowicz/cookiecutter-hypermodern-python—the template this library uses—seems to be doing the exact same migration:

@paw-lu paw-lu mentioned this issue Jan 16, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Beta release
Development

Successfully merging a pull request may close this issue.

Move documentation to MyST paw-lu/nbpreview
1 participant
@paw-lu