Settings

In order to use this extension, you must configure the following settings.

ubcode.needsJson

Specify needs.json path. The file is the primary source of the language server features and is generated by building your Sphinx-Needs project with the needs builder.

It can be generated automatically by config needs_build_json , or manually by build needs .

ubcode.srcDir

Specify source directory of current Sphinx-Needs project. Normally, the source directory is the directory that contains conf.py .

ubcode.activateFiles

Specify a list of supported languages when extension got activated. Default supported languages are restructuredtext and python .

When opened file that is resolved to specified language by VS Code, then Sphinx-Needs language features will be available.

Example:

"ubcode.activateFiles": [
     "restructuredtext",
     "python",
     "plaintext"
 ]

All items in the list of ubcode.activateFiles must match the VS Code supported language identifiers .

Hint

• After update settings of activateFiles , restart VS Code.

ubcode.explorerOptions

Specify a list of comma seperated string of need options to display at Explorer View . Default is: [“status”, “links”, “tags”].

Example:

"ubcode.explorerOptions": ["type", "description"]

ubcode.explorerItemHoverOptions

Specify a list of comma seperated string of need options to be displayed when hover over need ID at Explorer View . Default is: [“tags”].

Example:

"ubcode.explorerItemHoverOptions": ["tags", "doctype"]

ubcode.folders

Specify a list of objects of ubcode.needsJson and ubcode.srcDir to support multiple Sphinx projects inside one workspace. If this is set, the ubcode.srcDir setting is ignored. Default is: [].

Example:

"ubcode.folders": [
   {
      "needsJson": "${workspaceFolder}/doc2/needs.json",
      "srcDir": "${workspaceFolder}/doc2"
   },
   {
      "needsJson": "${workspaceFolder}/doc1/needs.json",
      "srcDir": "${workspaceFolder}/doc1"
   }
]

ubcode.licenseKey

Specify the license key for ubCode: A 23 characters long string, e.g. MUYVD-LSEBY-CXHRQ-XFAGY.

Example:

"ubcode.licenseKey": "MUYVD-LSEBY-CXHRQ-XFAGY"

To get a license key to unlock all features of ubCode, please contact useblocks GmbH .

Settings configuration

You can configure the settings of this extension in two ways:

1. Open .vscode/settings.json and specify above settings manually.

   

2. Go to the VS Code preferences UI and configure the settings.

   

Hint

• ${workspaceFolder} is supported.