feat: generate json help strings for use in docs/website #2158
Conversation
| @@ -3449,6 +3450,8 @@ pub const Keybinds = struct { | |||
|
|
|||
| /// Like formatEntry but has an option to include docs. | |||
| pub fn formatEntryDocs(self: Keybinds, formatter: anytype, docs: bool) !void { | |||
| if (build_config.building_docs) return; | |||
There was a problem hiding this comment.
What's going on here? Just trying to understand it :)
There was a problem hiding this comment.
It's a chicken-and-egg problem. While building the json & help strings docs you don't have access to the help strings so you get an error trying to import help_strings. Turning formatEntryDocs and one other spot into no-ps when building the json & help strings fixes that.
|
Sorry for the late review here... trying to dig myself out of the PR hole now. 😄 I think what I'd rather see for longer term maint is a generalization so that things like I think we could further continue to use this in different places so that we aren't reimplementing all the parsing and extracting each time. I don't like closing PRs, but doing this myself would be a lot of work and I think it'd be better to open a new one with this work. In the new PR I'd love to just see the parsing part (and probably converting |
note that this code should eventually be used to enhance the helpgen and the man pages since it goes a bit deeper and pulls out doc strings for enums.