Enable sync scrolling for .. included:: files
#851
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
In order to support included files, the webview code needs access to the source uri in addition to the line number. Rather than even attempt to force uris to work with CSS classes, the `SourceLocationTransform` includes a hidden div with a list of `<span>` elements, one for each location marker. These `<span>` elements have `data-uri` and `data-line` attributes containing the necessary information to make sync scrolling work. Each element has a `data-id` attribute which corresponds to a CSS class `esbonio-marker-<id>` which links the location which its corresponding location in the DOM
This aligns the `webview.js` file injected into HTML to the updated source location information to add support for mutliple source files.
This aligns the language server with recent changes to enable synchronised scrolling across multiple source files. Additionaly, rather than send a custom `editor/scroll` notification to the client, the server will now send a `window/showDocument` request taking advantage of the `selection` parameter. This *in theory* should reduce the amount of integration work required to enable sync scrolling in new clients.
Running pytest with the `--enable-devtools` flag will enable the use of `lsp-devtools` with the sphinx agent instance under test
Now that we have added a custom node, objects from the `sphinx_agent` module can end up in Sphinx's `environment.pickle` file. This means in order to be unpickled correctly Python needs to be able to do something like `from sphinx_agent.X import Y` However, the pytest process does not have the same Python path as the sphinx agent process that created the `environment.pickle` file. So when trying to load the environment in the `app` fixture, it fails and the tests that depend on it are not running with the right data available. To mitigate this, the `app` fixture temporarily puts the `esbonio/` folder onto `sys.path`, making the `sphinx_agent` module available to the pytest process and the environment is unpickled correctly. This doesn't necessarily feel like a great solution, but it appears to work. Finally, the fixture switches from using `sphinx.application.Sphinx` to `sphinx_agent.app.Sphinx` as the `sphinx_agent` based extensions depend on the extra `esbonio` attribute.
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.
This also improves the resolution of the scrolling as well as handling the case where the client asks to scroll to a line that doesn't have a corresponding marker. Closes #786
Closes #784