RST preview¶

ubCode provides a real-time RST preview that is synchronized with the editor:

A lot of markup problems cannot be detected in a continuous integration system as most input is valid RST in principle, it is just not what the user intended.

The RST preview shows the user instantly how the RST will be parsed by Sphinx. The preview is a great way to learn RST syntax and to see how the RST will be rendered by Sphinx. The goal is not to replace the final Sphinx HTML output, but to get early insights whether the written RST code is as expected.

Need cards¶

A need-type directive (a req / spec / … from your needs.types) renders in the preview as a need card: a header with the need’s type, title, and id, a meta table of its fields and links, and the need’s body.

Once the project has been indexed in the background, the card is hydrated to show the need as it will actually build:

field values reflect any needextend applied elsewhere in the project (so the card shows the effective, post-extend value, not just the source directive);
each outgoing link becomes a clickable cross-reference that navigates to the linked need’s location;
a “links back” section lists the incoming links — the needs that link to this one — data that does not appear in the source file at all.

Until the index is available the card still renders, using the field values written directly in the directive; the hydrated data appears on the next update once indexing completes.