Automatically document the generic plot options #1526
Merged
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.
This PR adds a new
Referencetop-level section (folder is calledrefasreferenceis already taken by the Reference Gallery) that for now includes this:The Plot Options page includes a table per options group (e.g.
Data Options,Resampling Options). These tables are automatically built from the class docstring of theHoloViewsConverterobject. This is done via a custom Sphinx extension that leveragesnumpydocto parse the docstring. To get the table to format the content nicely, I had to touch the docstrings in a few places. Ultimately, we should enable some sort of docstring validation to make sure it is appropriately formatted.The Data Options page is mostly a placeholder at the moment (for future PRs). While the Plot Options page only contains tables, this page should contain the table but also subsections that give more information about the options and most importantly include plots demonstrating their effects. This is why this page is a Notebook.
When this PR is merged, we should quickly be able to remove the
Customizationuser guide, redirecting to thePlot Optionspage.EDIT:
