[Task] First run experience for pipenv managed single folder

[lextm]

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

Python dependencies added to pipenv

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

• Obfuscar Docs

Initial Steps

1. (Optional) Use a tool like pyenv to set local Python version,

   pyenv local 3.12

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

   pipenv install

   The Python version used for this virtual environment is specified in Pipfile.

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

4. 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