reStructuredText Table Generator

Fill in the grid and copy a reStructuredText simple table. The equals-sign rules are placed correctly and the columns are padded, which is the part that is tedious to do by hand and easy to get subtly wrong.

From

The only part of this site that uses a server. The address is sent to it so the page can be fetched, because a browser is not allowed to fetch someone else's page itself. Your own files are never involved.

Nothing here is uploaded. The parsing happens on this page.
Edit
Paste or upload something above and it will appear here.
ToDataMarkupDocumentsCodeSchemasImages

The output will appear here once there is a table to convert.

Why the rules matter

A simple table is defined by its rules: a line of equals signs above the header, one below it and one at the end. The rule under the header is what tells the parser the first row is a header rather than data. Leave it out and the table renders with no heading and no error.

The rules also define the columns. Each run of equals signs marks one column and its width, so a value wider than its rule breaks the table. That is the failure people hit when they edit a table by hand and add a longer entry without widening the rule above it.

Simple tables and grid tables

reStructuredText has two table syntaxes. Simple tables, which this generates, are compact and cannot have merged cells or content that wraps across lines. Grid tables draw every border with dashes and pipes and can do both, at the cost of being far more work to maintain.

For most documentation a simple table is the right choice. Reach for a grid table only when you actually need a merged cell.

Where it renders

Sphinx, Read the Docs, Docutils, and anything that reads a .rst file. GitHub renders reStructuredText in a repository too, so a README.rst with a table in it displays correctly there.

Questions

My table renders as plain text. What is wrong?

Almost always the blank line. A table needs one before it and one after it, otherwise the parser treats it as part of the surrounding paragraph.

Can a cell contain a line break?

Not in a simple table. Use a grid table if you need it, or keep the cell short.

Do the columns have to line up exactly?

Yes, and that is the difference from Markdown. The rules define where the columns start and end, so a value that overruns its rule is read as belonging to the next column.

Already have the data somewhere else?

Other generators