Enhance Sphinx and Sphinx-Needs editing experience

ubCode features a lightning-fast language server that deeply understands Sphinx-Needs to provide a joyful editing experience in VS Code.

Documentation: https://ubcode.useblocks.com/

ubCode is currently in open beta and improving rapidly. If you have any feedback or issues, please let us know:

• Public feedback
• Private support

Real-time indexing of RST files

A Rust based RST indexer provides real-time insights into your Sphinx projects. The data is used to power many of the features below.

If the setting index_on_save is enabled, the indexer will re-index the whole project when a file is saved. This ensures that the index is always up-to-date.

Real-time preview of RST files

ubCode maintains a continuously updated preview of your RST files. It shows how Sphinx / docutils will see your RST input. Common mistakes can be detected such as wrong indentation, broken lists or directives.

Navigation / LSP features

The indexer powers many navigation features such as "Go to Definition", "Find all References" and "Peek Definition".

Linting & Diagnostics

Common RST linting issues are detected and highlighted in real-time.

For project wide diagnostics a dedicated view is available:

Formatter

ubCode integrates an RST formatter that can fix lint issues and integrates deeply with RST and known directives. It integrates into VS Code using the Format Document command or on save with a configuration like this:

  "[restructuredtext]": {
    "editor.defaultFormatter": "useblocks.ubcode",
    "editor.formatOnSave": true
  },

The formatter can also wrap paragraphs to a given line length, so you do not have to worry about that anymore. Its behavior can be customised.

Large projects

ubCode is designed to handle large Sphinx projects with thousands of files and need items.

Filtering

License

ubCode and its companion CLI app ubc is available free of charge with all features for public open source projects. For private projects, a paid license is required.