reST&markdown hybrid project possible ?

21 views
Skip to first unread message

Wolf Drechsel

unread,
Sep 22, 2021, 3:10:02 AM9/22/21
to sphinx-users

Hello,

I'm new to this group. Happened to be part of a documentation project in sphinx, the guys who started it already did ~50% in reST. I now should deliver the remaining 50%, but I'm very much used to markdown and not so eager to learn reST.

Is it possible to conduct this project as a hybrid:
I'm contributing my markdown bits, the other fellows continue using reST? -

In case: How could that be done?

Cheers, Wolf

Kevin Cole

unread,
Sep 22, 2021, 7:23:18 AM9/22/21
to sphinx...@googlegroups.com, ​Wolf Drechsel
Pandoc is your friend here:


Write in whatever you like -- in your case, Markdown, and convert to whatever you like later -- e.g. reStructuredText.

--
Physical
[Photo: Kevin Cole]
("ubuntourist")
Brain-Washington,
Disenfranchised City

Juan Luis Cano Rodríguez

unread,
Sep 22, 2021, 11:57:05 AM9/22/21
to sphinx...@googlegroups.com
You can also use something like MyST-Parser https://myst-parser.readthedocs.io/, a Sphinx extension that will take care of your `.md` bits. That way, you can keep the `.rst` ones, and add new docs in MyST. Sphinx will read both without problems.

Cheers,
Read the Docs

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/71a6ab1b-49f7-45de-a9c5-30308f403e84n%40googlegroups.com.

Wolf Drechsel

unread,
Sep 27, 2021, 4:47:42 AM9/27/21
to sphinx-users
Hello, thank you very much for your time, this looks promising. I'll check it out with our Sphinx experts.
Cheers, Wolf
Reply all
Reply to author
Forward
0 new messages