Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop injecting Python interpreter and improve Sphinx Process tree #881

Merged
merged 4 commits into from
Aug 21, 2024

Conversation

alcarney
Copy link
Member

In an attempt to simplify the first time setup (#733) this PR stops the VSCode extension from automatically injecting the currently active Python interpreter into the configuration sent to the server.

This will force users to have to set the esbonio.sphinx.pythonCommand setting, which while annoying to those who were relying on the previous behaviour I think will be an improvement in the long run.

  • It's less "magic" and makes the setup instructions the same to all user's of Esbonio (not just those using VSCode!)
  • It's relatively easy to set the setting, especially if you use an environment manager like hatch or poetry
  • It should encourage people to save the setting to a pyproject.toml file, further simplifying the setup for the Nth user to a project.

This PR also includes some updates to the Sphinx Process tree!

image

Each Sphinx process can be further expanded to include

  • The command used to select the python environment
  • The sphinx-build command used
  • The builder name and a (simple!) tree view allowing the user to inspect the build folder

This commit extends the Sphinx Process tree view to include additional
details about the Sphinx processes currently managed by the server.

- The value of `esbonio.sphinx.pythonCommand`
- The value of `esbonio.sphinx.buildCommand`
- The current builder name, as well as a (basic!) file tree exposing the
  contents of the build directory. This finally makes the files produced
  when esbonio writes to its default build dir easily accessible.

Including these details not only helps the user figure out the current
state of the server, but it provides an obvious location for additional
management/maintainance commands in the future
@alcarney alcarney merged commit b875c03 into swyddfa:develop Aug 21, 2024
2 of 3 checks passed
@alcarney alcarney deleted the vscode branch August 21, 2024 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant