You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This adds a custom sphinx directive (dhautofunction) that takes the output of sphinx autofunction and extracts relevant data. Here is a snippet of the generated item in the area doc (in the doc it is all on one line)
<ParamTable param={{
"module_name": "deephaven.plot.express.",
"name": "area",
"description": "Returns an area chart",
"parameters": [{"name": "table", "type": "Table | None", "description": "A table to pull data from.", "default": "None"}, ...],
"return_description": "A DeephavenFigure that contains the area chart",
"return_type": "DeephavenFigure"}}
/>
module_name was just an alias I created for info extracted from the desc_addname node as it seems like it would generally be the module
all of the keys are constant otherwise, besides default in the params objects, which may or may not be there
from what I understand, these nodes, as weirdly structured as they are, do have some consistency. For example, the desc node Contains one or more desc_signature nodes and then a single desc_content node.
I don't think passing params directly would make anything easier on the extension side, but it could be done if it's preferable for the usage side
This file contains hidden or 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
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.
Fixes #566
This adds a custom sphinx directive (
dhautofunction) that takes the output of sphinxautofunctionand extracts relevant data. Here is a snippet of the generated item in the area doc (in the doc it is all on one line)