Installation¶

Install extension from VsCode Marketplace¶

Install extension Sphinx-Needs from VsCode Marketplace.

• Open VsCode

• Open view of Extension (Ctrl+Shift+X)

• Search Extension Sphinx-Needs, check if publisher identifier matches: useblocks.sphinx-needs-vscode

• Install

Install extension from .VSIX file¶

• Clone the source repository

  git clone https://github.com/useblocks/sphinx-needs-vscode.git
  cd sphinx-needs-vscode
  

• Build the Sphinx-Needs-VSCode extension .vsix file locally using the command:

  npm install vsce
  vsce package --baseContentUrl https://github.com/useblocks/sphinx-needs-vscode --baseImagesUrl https://github.com/useblocks/sphinx-needs-vscode
  

• Install the sphinx-needs-vscode-*.*.*.vsix file:

  • Using your terminal, run the command below

    code --install-extension [path-to-sphinx-needs-vscode-*.*.*.vsix]
    

  • or Using the menu, click on the “…” button at the top right and select Install from VSIX.

• Restart VsCode after installation.

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

• or you can open .vscode/settings.json, and specify the path:

  

• Open any .rst file to activate the extension.