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 docs to Markdown #1378

Closed
jtpio opened this issue Aug 10, 2023 · 0 comments · Fixed by #1381
Closed

Convert docs to Markdown #1378

jtpio opened this issue Aug 10, 2023 · 0 comments · Fixed by #1381
Assignees
@trungleduc
Labels
documentation
Milestone
0.5.0

Comments

@jtpio
Copy link
Member

jtpio commented Aug 10, 2023

Problem

Currently the documentation in reStructuredText: https://github.com/voila-dashboards/voila/blob/main/docs/source/customize.rst

Many Jupyter projects have moved to writing their docs in markdown with myst, so we should consider doing the same for Voila.

Suggested Improvement

Using the migration tool:

pip install rst-to-myst[sphinx]
rst2myst convert docs/**/*.rst

As an example Voici: voila-dashboards/voici#60
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@trungleduc trungleduc

Labels
documentation
Projects
None yet
Milestone
0.5.0
Development

Successfully merging a pull request may close this issue.

Update documentation trungleduc/voila
2 participants
@jtpio @trungleduc