[Task] First run experience for poetry managed single folder

[lextm]

The user must be using VS Code to work on a single folder, which uses poetry to spin out a virtual environment.

Python dependencies added to poetry

To make sure esbonio extension works properly, this folder must have the following dependencies installed (as dev dependencies or just normal ones),

• sphinx
• the actual sphinx theme (such as sphinx-rtd-theme)
• any other sphinx extensions (such as sphinx-copybutton)

esbonio shouldn't be installed, as the extension acquires it automatically from the installation folder.

Examples

• PySNMP Library

Initial Steps

1. The virtual environment must be properly configured and created,

   poetry env use 3.12
   poetry env info --path
   poetry install

2. Once opened this folder in VS Code, the user can open conf.py and select which Python interpreter to use via Microsoft Python extension.

   The user might need to manually add the environment path using the output of poetry env info --path.

3. Esbonio language server is notified by this change and starts to build the web pages.

Live preview and other features are also ready then.

Related Items

#736