Initially I was writing my documentation in README.md file as a markdown format. I can than convert the markdown file into reStructuredText(rst) extension for Sphinx Doc using pandoc --from=markdown --to=rst --output=index.rst index.md ; its solution link.

Now I am writing my documenration as in README.org file. Is it possible to convert files in org directly to rst extension for Sphinx Doc? or should I first convert org into markdown and then into rst format?

  • 2
    You might want to try out ox-rst. The main problem with going through Markdown will be the fact that there are many Markdown formats and there is no necessary relation between what ox-md.el will produce and what pandoc requires to produce rst: it will be a trial-and-error process.
    – NickD
    Jun 1 at 18:42
  • This generated rst format seems different than pandoc generates. Like 1 Setup ------------- where should not be any number before each item in general
    – alper
    Jun 1 at 19:31
  • I guess the question is: does Sphinx like it or not? If not, you should open an issue at the ox-rst site.
    – NickD
    Jun 1 at 19:48
  • I iterate through multiple github repos that has .rst files and non of the have numbering before the headers. Like ox-rst generates as: Create app password // opened issue: github.com/msnoigrs/ox-rst/issues/57
    – alper
    Jun 1 at 22:58
  • Org pandoc Org -> rst?
    – mankoff
    Jun 2 at 13:39


Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Browse other questions tagged or ask your own question.