Report sphinx-build progress #659
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
By patching Sphinx's progress reporting functions, we're able to send `$/progress` messages to the language server, which in turn can report the build progress to the client. This also gives us the opportunity to tidy up some of the build output from Sphinx - `status_iterator` messages no longer report every item Before ``` reading sources... [ 61%] lsp/editors/vim reading sources... [ 65%] lsp/editors/vscode reading sources... [ 69%] lsp/extending reading sources... [ 73%] lsp/extending/api-reference ``` After ``` reading sources... ``` Note that the original behavior can be restored by passing a `-v` flag to the configured `sphinx-build` command - `progress_messages` are no longer split across multiple lines. Before ``` copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done ``` After ``` copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done ```
Using the create work done progress API, the server will now request for a work done token and report the progress of each Sphinx build.
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.
Using the create work done progress API, the server will now report sphinx build progress to the client.