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

Add support for missing extensions #913

Merged
merged 3 commits into from
Oct 16, 2024

Conversation

alcarney
Copy link
Member

image

In an attempt to help with first-time setup issues, this PR enables esbonio to continue to work when configured to use an incomplete environment (though for obvious reasons sphinx itself 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

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 alcarney merged commit eca2086 into swyddfa:develop Oct 16, 2024
12 of 13 checks passed
@alcarney alcarney deleted the missing-extensions branch October 16, 2024 18:35
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.

sphinx-build command line parsing broken on Sphinx 8.1
1 participant