Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@maximlt
Copy link
Member

@maximlt maximlt commented Mar 14, 2025

This PR adds a new Reference top-level section (folder is called ref as reference is already taken by the Reference Gallery) that for now includes this:

  • Plot Options
    • Data options

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 the HoloViewsConverter object. This is done via a custom Sphinx extension that leverages numpydoc to 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 Customization user guide, redirecting to the Plot Options page.

EDIT:
image

@maximlt
Copy link
Member Author

maximlt commented Mar 17, 2025

The dev site was built without any problem. I'm going to go ahead and merge it as I have other pieces of work that depend on it.

@maximlt maximlt merged commit 57fa9d4 into main Mar 17, 2025
23 of 28 checks passed
@maximlt maximlt deleted the api_plot_options branch March 17, 2025 12:37
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.

2 participants