Add support for missing extensions #913
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alcarney
force-pushed
the
missing-extensions
branch
from
0588446 to
6a631dd
Compare
The sphinx-agent will no longer crash if the configured environment is
missing an extension. Instead the error is suppressed and the agent
will attempt to report it to the user as a diagnostic
However, the diagnostic will only work if the extensions are declared
in `conf.py` using the "standard" Sphinx format i.e.
```python
extensions = [
'a',
'b',
...
]
```
alcarney
force-pushed
the
missing-extensions
branch
from
92a8f35 to
f4fb3f9
Compare
This was referenced Oct 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In an attempt to help with first-time setup issues, this PR enables
esbonioto continue to work when configured to use an incomplete environment (though for obvious reasonssphinxitself still has to be present). It will suppress errors generated from missing extensions allowing users to continue to work - albeit with reduced knowledge of their project.When possible, the server will report any missing extension modules as a diagnostic
This PR also fixes #912