Skip to article
Documentation

Editing and tables

Write sections, directives, references, and aligned RST tables.

On this page

Create a document#

Create index.rst:

Project guide
=============

Getting started
---------------

A paragraph with **bold** text.

.. note::

   Keep the blank line before this indented content.

.. code-block:: python

   print("hello")

Open the split preview and confirm the heading, note, and code render. RST indentation and blank lines carry meaning; inspect them first if a directive becomes plain text.

Complete directives and roles#

Type .. for directive completion and : for roles. Reference completion assists with labels and document paths inside roles such as :ref: and :doc:. Domain-qualified lookups distinguish names such as Python functions from similarly named C or JavaScript symbols.

Edit tables#

Use the table creation action from Generate, then right-click a table for row/column insertion, deletion, and movement. Reformat to align cells. Check the preview after adding multiline text or changing the table shape.

Structure view and breadcrumbs follow section hierarchy. Inspections flag duplicate titles, inconsistent section levels, and unresolved references. Code blocks can receive injected language assistance as well as rendered highlighting. Use live templates for common notes, code blocks, includes, and references.

Manual for version 2026.2.4 · Reviewed