-
Notifications
You must be signed in to change notification settings - Fork 0
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
Task 10337 Add doc folder #51
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code is great but I think we should make sure this is the approach we want.
Like task.rst, we must identify a maintainable way to update and package external documentation files.
yocto-docs/bitbake-user-manual/bitbake-user-manual-metadata.rst
Outdated
Show resolved
Hide resolved
yocto-docs/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
Outdated
Show resolved
Hide resolved
I tested that the .vsix properly showed hover documentation for variables. However it doesn't for tasks but I don't think we implemented that yet. |
a46c55c
to
471d226
Compare
Yes, we didn't implement it in the |
LGTM |
Since we don't want to read users' bitbake folder, I added a doc folder at the project root. (Currently, the folder contains the files needed by the
bitbakeDocScanner
parse functions)I passed the extension path (which points to
client/
in our case) ininitializationOptions
so the server can receive it. The path is then used to construct the doc path inbitbakedocScanner
. So after the compilation, the server still knows the correct path (since it is relative to the client folder). A default path is provided to pass the tests. (Or set the path in tests?)