Documentation | Convert documentation to MyST or Markedly Structured Text (#40)
Amar Takhar (@amar)
gitlab at rtems.org
Wed Oct 23 19:34:19 UTC 2024
Amar Takhar created an issue: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/40
Assignee: Amar Takhar
## Summary
<!--Please provide as much information as possible such as error messages or attaching logs-->
We use Markdown for all our documentation outside of this repository. MyST https://myst-parser.readthedocs.io/en/latest/ has been popular for quite a while and has extensions to VS Code and others.
It's a lot nicer to use than reST and would unify our documentation across the entire project. I would handle conversion.
Of note: Not much actually changes as far as markup goes reST and MarkDown are pretty similar but all the Xref code will change. I'll do a sample repository at some point in the future.
## Steps to reproduce
### Pre-set options
--
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/40
You're receiving this email because of your account on gitlab.rtems.org.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20241023/e3300014/attachment.htm>
More information about the bugs
mailing list