Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

useblocks/sphinx-needs-vscode

Repository files navigation

Note

THIS EXTENSION IS DEPRECATED AND UNMAINTAINED. PLEASE TRY THE NEW EXTENSION ubCode.

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:

    image

  • Open any .rst file to activate the extension.

Features

Code Completion:

image

Hover:

image

Goto Definition:

image

Find References:

image

ID Selection:

image

ID Auto Generation:

image

User Interface

Sphinx-Needs Views:

image

Sphinx-Needs Current Explorer View

image