Installation

Prerequisites

To run this extension setup a sphinx documentation project that is using the sphinx-needs extension.

Also build the needs.json file.

Installation of the extension

1. Open your Sphinx documenation project into your vscode workspace.

2. Install the Open-Needs IDE extension from the official VS Code marketplace (extension tab on the left side fo the IDE).

3. Open the Settings page [Ctrl + ,] and search for open-needs:

   1. Update the Build Path. E.g. /home/my-user/my-project/docs/_build/need.

   2. Update the Docs Root. E.g. /home/my-user/my-project/docs

   3. Update the pythonPath. E.g. /home/my-user/my-project/.venv/bin/python. Default is system python path. E.g. /usr/bin/python.

   4. Update the confPath. E.g. /home/my-user/my-project/docs/my-conf.py. Default is conf.py in document root. E.g. /home/my-user/my-project/docs/conf.py.

4. Open a reStructuredText file (*.rst) in workspace to trigger the activation of the extension.

5. The first time you run the extension it will ask for permission to install the Python package needls. Click Yes to trigger the installation.

Alternatively you can install needls manually:

1. Activate your Python virtual environment

2. Install the python package:

   python -m pip install pip --upgrade
   python -m pip install git+https://github.com/open-needs/open-needs-ide