Installation

Install from Marketplace#

1. Open Settings → Plugins → Marketplace in your JetBrains IDE. On macOS, Settings is in the application menu.
2. Search for reStructuredText Pro, or open the product on JetBrains Marketplace to identify the correct listing.
3. Choose Install and accept any required plugin dependencies. Restart the IDE if prompted.
4. If the IDE requests activation, start the offered trial or sign in with the JetBrains Account that holds your subscription. The IDE’s plugin licensing dialog shows the options available for this product.
5. Open the project directory rather than an isolated file so project-aware features can resolve dependencies and configuration.

Prepare the environment#

IDE compatibility: IntelliJ IDEA 2026.2+. Check the Marketplace list for other editions and their supported versions.

The built-in preview and basic editing work without Python. For project-accurate Sphinx rendering, install Sphinx and the extensions used by the project, and configure the sphinx-build executable. Use the published release’s Marketplace compatibility list for your IDE.

The approved release documented here is 2026.2.4, for platform build 262.0 or newer. The Marketplace Versions tab lists compatible downloads for individual IDE editions. An older IDE may receive an older compatible plugin with different features.

Verify the installation#

Open Settings → Plugins → Installed and confirm that reStructuredText Pro is enabled. Then follow Editing and tables to exercise the main workflow. Expected results and the necessary project files are described there.

Install a downloaded archive#

For an offline installation, download a compatible ZIP from the Marketplace versions page. In Settings → Plugins, open the gear menu, choose Install Plugin from Disk…, select the ZIP without unpacking it, and restart if requested. Required dependencies and external tools must also be available.

Update or uninstall#

Use Settings → Plugins → Installed to update, disable, or uninstall the plugin. Restart when requested. Keep your project sources and configuration in version control before applying updates that change generated files or external-tool behavior.