Add support for :external: role completions
#856
Merged
Conversation
This file contains 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
This adds code to dump all objects defined in intersphinx inventories into the `objects` table in the SQLite DB. So that the language server can distinguish between local objects and objects defined in another project, the `objects` table has been extended to include a `project` column. It will be `NULL` for objects in the local project or be set to the intersphinx inventory name otherwise. To ensure that the language server is able to surface these items in completions this commit updates the domain role indexing code to also store `external:domain:role` and `external+invname:domain:role` variants of the role in the DB. This feels... hacky but seems to work well. Maybe this can be revisited in the future and improved with a more dynamic role completion system...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
While it works, this feels a little bit like a hack, since to enable the completions the sphinx agent generates a role definition for every combination of
external,+invnameanddomain:objtype. I'm sure a future version of this can be smarter about it.The role completions are also starting to feel perhaps a little clunky? The completions can get quite long... perhaps having the server return just
externaland then on the+return a list ofinvnamescould be potential improvement to explore...Closes #464, supersedes #514