Parsing reStructuredText into HTML

python restructuredtext python-sphinx docutils
Ram Rachum picture Ram Rachum · Jul 11, 2011 · Viewed 9.3k times · Source

I'm making a framework in which I let developers describe their package using reStructuredText. I want to parse that reStructuredText into HTML so I can show it in a GUI.

I'm familiar with the excellent Sphinx, but I've never otherwise parsed reStructuredText. I imagined something like a function that takes a string of reStructuredText, and possibly several additional arguments, and returns a string of HTML.

So I looked into Docutils, which is responsible for parsing reStructuredText. I couldn't understand at all how to find this function. Documentation on the web is spotty. Many of the functions in the docutils.parsers.rst module seemed to be geared toward filenames. I don't have filenames! I'm just handling strings.

I tried creating a Parser and a Document and using the parse method, but I just get an error about a missing .tab_width setting.

Does anyone know how to parse reStructuredText into HTML?

Answer

Anurag Uniyal picture Anurag Uniyal · Jul 11, 2011

Try something like this:

>>> from docutils.core import publish_string
>>> publish_string("*anurag*", writer_name='html')

publish_string accepts a strings and outputs a string or you can use publish_parts to get specific parts of html document e.g.

>>> from docutils.core import publish_parts
>>> print publish_parts("*anurag*", writer_name='html')['html_body']
<p><em>anurag</em></p>

Related questions

How would I cross-reference a function generated by autodoc in Sphinx?

I am using the Sphinx autodoc feature to generate documentation based on the docstrings of my Python library. The syntax for cross referencing is found here A label must precede the section in order to allow that section to be …

Read More
How to document a module constant in Python?

I have a module, errors.py in which several global constants are defined (note: I understand that Python doesn't have constants, but I've defined them by convention using UPPERCASE). """Indicates some unknown error.""" API_ERROR = 1 """Indicates that the request was …

Read More
Include my markdown README into Sphinx

I would like to include my project's README.md into my Sphinx documentation like in Can sphinx link to documents that are not located in directories below the root document? - which is that in the resulting Sphinx html documentation …

Read More