swyddfa / esbonio

A language server for working with Sphinx projects.
https://docs.esbon.io/
135 stars 22 forks source link

Implement a `${defaultBuildDir}` placeholder variable #903

Closed alcarney closed 1 month ago

alcarney commented 1 month ago

Unless esbonio finds a sphinx-build command to use from the user's config it will attempt to guess something reasonable. During this process it generates a default build directory to use, in a subfolder of platformdirs.user_cache_dir() so that it does not interfere with the user's files.

Up until now, the moment a user sets their own sphinx-build command this behavior is lost, which can lead to issues on some systems.

This PR introduces a ${defaultBuildDir} placeholder value that the user can use to provide their own build flags, while maintaining the default choice of build directory provided by esbonio.

Closes #865