Sphinx-Needs for Visual Studio Code

Sphinx-Needs is a Sphinx extension to write documentation.

This Sphinx-Needs-VSCode extension aims to bring an enhanced experience for editing Sphinx-Needs projects when using VSCode.

It provides language features like code completion, goto definition, and hover.

Quick Start

• Install the Sphinx-Needs-VSCode extension.

• Config workspace settings of needsJson and srcDir, to specify the needs JSON path and source directory of your Sphinx-Needs project.

• Open .vscode/settings.json, and specify the path:

  

• Open any .rst file to activate the extension.

Features

Code Completion:

Hover:

Goto Definition:

Find References:

ID Selection:

ID Auto Generation:

User Interface

Sphinx-Needs Views:

Sphinx-Needs Current Explorer View