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 textDocument/convertDocumentation request #1851

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

matthewbastien
Copy link
Member

@matthewbastien matthewbastien commented Dec 4, 2024

Support documentation live preview in Swift files by handling requests to convert documentation using Swift DocC.

This PR adds a new request method textDocument/convertDocumentation that responds with a JSON encoded RenderNode created using Swift DocC's ConvertService. This request has two parameters:

  1. A text document for which to convert documentation
  2. A position within the text document that will be used to find the nearest documentable symbol

The request is only supported on macOS and Linux until Swift DocC can be made to support Windows.

@matthewbastien matthewbastien force-pushed the convert-documentation branch 2 times, most recently from 3992c85 to 55b492d Compare December 6, 2024 15:24
@matthewbastien matthewbastien marked this pull request as ready for review December 19, 2024 15:41
@matthewbastien
Copy link
Member Author

@swift-ci please test

@matthewbastien
Copy link
Member Author

@swift-ci please test

1 similar comment
@matthewbastien
Copy link
Member Author

@swift-ci please test

@matthewbastien
Copy link
Member Author

@swift-ci please test windows platform

@matthewbastien
Copy link
Member Author

@swift-ci please test

@matthewbastien
Copy link
Member Author

@swift-ci please test windows platform

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.

1 participant