FAQ¶
General¶
New to the ecosystem? What is docutils? maps the core terms in one page.
What is reST, RST, reStructuredText?¶
reStructuredText is a markup syntax, similar to Markdown. Learn it from the official primer and quick reference.
What is docutils?¶
docutils is a Python package for parsing and publishing markup. The default docutils package supports reStructuredText. It can also parse Markdown when a third-party parser such as myst-docutils or myst-parser is installed — see What is docutils? for the details.
Django Docutils¶
Do I need this package to parse reStructuredText in Django?¶
No! docutils can always be used directly.
This package adds Django template and view helpers around docutils.
What does this package provide?¶
You get three entry points for rendering reStructuredText via docutils in Django:
Can I copy code from this project to my own?¶
Yes. The project is released under the MIT license, so you can view the codebase and copy what you need.