Skip to content
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

Doc: rename the Pandas section as Tabular #1260

Merged
merged 5 commits into from
Jan 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
'nbsite.gallery',
'nbsite.analytics',
'sphinx_copybutton',
'sphinxext.rediraffe',
]

myst_enable_extensions = ["colon_fence"]
Expand All @@ -66,10 +67,9 @@
'reference': {
'title': 'Reference Gallery',
'intro': (
'Incomplete Reference Gallery containing some small '
'examples of different plot types.'),
'Find the list of supported libraries on the `Integrations <../user_guide/Integrations.html>`_ page.'),
'sections': [
'pandas',
'tabular',
'geopandas',
'xarray',
]
Expand All @@ -81,6 +81,31 @@
'goatcounter_holoviz': True,
}

rediraffe_redirects = {
# When the pandas section was renamed tabular:
'reference/pandas/andrewscurves': 'reference/tabular/andrewscurves',
'reference/pandas/area': 'reference/tabular/area',
'reference/pandas/bar': 'reference/tabular/bar',
'reference/pandas/barh': 'reference/tabular/barh',
'reference/pandas/bivariate': 'reference/tabular/bivariate',
'reference/pandas/box': 'reference/tabular/box',
'reference/pandas/errorbars': 'reference/tabular/errorbars',
'reference/pandas/heatmap': 'reference/tabular/heatmap',
'reference/pandas/hexbin': 'reference/tabular/hexbin',
'reference/pandas/hist': 'reference/tabular/hist',
'reference/pandas/kde': 'reference/tabular/kde',
'reference/pandas/labels': 'reference/tabular/labels',
'reference/pandas/lagplot': 'reference/tabular/lagplot',
'reference/pandas/line': 'reference/tabular/line',
'reference/pandas/ohlc': 'reference/tabular/ohlc',
'reference/pandas/parallelcoordinates': 'reference/tabular/parallelcoordinates',
'reference/pandas/scatter': 'reference/tabular/scatter',
'reference/pandas/scattermatrix': 'reference/tabular/scattermatrix',
'reference/pandas/step': 'reference/tabular/step',
'reference/pandas/table': 'reference/tabular/table',
'reference/pandas/violin': 'reference/tabular/violin',
}

html_context.update({
"last_release": f"v{release}",
"github_user": "holoviz",
Expand Down
36 changes: 18 additions & 18 deletions hvplot/plotting/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ def line(self, x=None, y=None, **kwds):
"""
The `line` plot connects the points with a continuous curve.

Reference: https://hvplot.holoviz.org/reference/pandas/line.html
Reference: https://hvplot.holoviz.org/reference/tabular/line.html

Parameters
----------
Expand Down Expand Up @@ -376,7 +376,7 @@ def step(self, x=None, y=None, where="mid", **kwds):
The `step` plot can be used pretty much anytime the `line` plot might be used, and has many
of the same options available.

Reference: https://hvplot.holoviz.org/reference/pandas/step.html
Reference: https://hvplot.holoviz.org/reference/tabular/step.html

Parameters
----------
Expand Down Expand Up @@ -475,7 +475,7 @@ def scatter(self, x=None, y=None, **kwds):

The `scatter` plot is a good first way to plot data with non continuous axes.

Reference: https://hvplot.holoviz.org/reference/pandas/scatter.html
Reference: https://hvplot.holoviz.org/reference/tabular/scatter.html

Parameters
----------
Expand Down Expand Up @@ -580,7 +580,7 @@ def area(self, x=None, y=None, y2=None, stacked=True, **kwds):
The `area` plot can be used to color the area under a line or to color the space between two
lines.

Reference: https://hvplot.holoviz.org/reference/pandas/area.html
Reference: https://hvplot.holoviz.org/reference/tabular/area.html

Parameters
----------
Expand Down Expand Up @@ -661,7 +661,7 @@ def errorbars(self, x=None, y=None, yerr1=None, yerr2=None, **kwds):
They are usually overlaid with other plots such as `scatter` , `line` or `bar` plots to
indicate the variability.

Reference: https://hvplot.holoviz.org/reference/pandas/errorbars.html
Reference: https://hvplot.holoviz.org/reference/tabular/errorbars.html

Parameters
----------
Expand Down Expand Up @@ -746,7 +746,7 @@ def ohlc(self, x=None, y=None, **kwds):
"""
The `ohlc` plot visualizes the open, high, low and close prices of stocks and other assets.

Reference: https://hvplot.holoviz.org/reference/pandas/ohlc.html
Reference: https://hvplot.holoviz.org/reference/tabular/ohlc.html

Parameters
----------
Expand Down Expand Up @@ -805,7 +805,7 @@ def heatmap(self, x=None, y=None, C=None, colorbar=True, **kwds):
This allows spotting correlations in multivariate data and provides a high-level overview
of how the two variables are plotted.

Reference: https://hvplot.holoviz.org/reference/pandas/heatmap.html
Reference: https://hvplot.holoviz.org/reference/tabular/heatmap.html

Parameters
----------
Expand Down Expand Up @@ -869,7 +869,7 @@ def hexbin(self, x=None, y=None, C=None, colorbar=True, **kwds):

`hexbin` offers a straightforward method for plotting dense data.

Reference: https://hvplot.holoviz.org/reference/pandas/hexbin.html
Reference: https://hvplot.holoviz.org/reference/tabular/hexbin.html

Parameters
----------
Expand Down Expand Up @@ -938,7 +938,7 @@ def bivariate(self, x=None, y=None, colorbar=True, **kwds):
`bivariate` plots can be a useful alternative to scatter plots, if your data are too dense
to plot each point individually.

Reference: https://hvplot.holoviz.org/reference/pandas/bivariate.html
Reference: https://hvplot.holoviz.org/reference/tabular/bivariate.html

Parameters
----------
Expand Down Expand Up @@ -1011,7 +1011,7 @@ def bar(self, x=None, y=None, **kwds):
represents the categories and the y axis represents the value scale.
The bars are of equal width which allows for instant comparison of data.

Reference: https://hvplot.holoviz.org/reference/pandas/bar.html
Reference: https://hvplot.holoviz.org/reference/tabular/bar.html

Parameters
----------
Expand Down Expand Up @@ -1102,7 +1102,7 @@ def barh(self, x=None, y=None, **kwds):

`barh` can be used on dataframes with regular Index or MultiIndex.

Reference: https://hvplot.holoviz.org/reference/pandas/barh.html
Reference: https://hvplot.holoviz.org/reference/tabular/barh.html

Parameters
----------
Expand Down Expand Up @@ -1162,7 +1162,7 @@ def box(self, y=None, by=None, **kwds):

`box` plots are most useful when grouped by additional dimensions.

Reference: https://hvplot.holoviz.org/reference/pandas/box.html
Reference: https://hvplot.holoviz.org/reference/tabular/box.html

Parameters
----------
Expand Down Expand Up @@ -1228,7 +1228,7 @@ def violin(self, y=None, by=None, **kwds):

Note that `violin` plots depend on the `scipy` library.

Reference: https://hvplot.holoviz.org/reference/pandas/violin.html
Reference: https://hvplot.holoviz.org/reference/tabular/violin.html

Parameters
----------
Expand Down Expand Up @@ -1291,7 +1291,7 @@ def hist(self, y=None, by=None, **kwds):
"""
A `histogram` displays an approximate representation of the distribution of continuous data.

Reference: https://hvplot.holoviz.org/reference/pandas/hist.html
Reference: https://hvplot.holoviz.org/reference/tabular/hist.html

Parameters
----------
Expand Down Expand Up @@ -1374,7 +1374,7 @@ def kde(self, y=None, by=None, **kwds):

The `kde` and `density` plots are the same.

Reference: https://hvplot.holoviz.org/reference/pandas/kde.html
Reference: https://hvplot.holoviz.org/reference/tabular/kde.html

Parameters
----------
Expand Down Expand Up @@ -1452,7 +1452,7 @@ def density(self, y=None, by=None, **kwds):

The `kde` and `density` plots are the same.

Reference: https://hvplot.holoviz.org/reference/pandas/kde.html
Reference: https://hvplot.holoviz.org/reference/tabular/kde.html

Parameters
----------
Expand Down Expand Up @@ -1528,7 +1528,7 @@ def table(self, columns=None, **kwds):
"""
Displays a 'table'.

Reference: https://hvplot.holoviz.org/reference/pandas/table.html
Reference: https://hvplot.holoviz.org/reference/tabular/table.html

Parameters
----------
Expand Down Expand Up @@ -1808,7 +1808,7 @@ def labels(self, x=None, y=None, text=None, **kwds):
`labels` are mostly useful when overlaid on top of other plots using the `*`
operator.

Reference: https://hvplot.holoviz.org/reference/pandas/labels.html
Reference: https://hvplot.holoviz.org/reference/tabular/labels.html

Parameters
----------
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ def get_setup_version(reponame):
# Additional packages required to build the docs
extras_require['doc'] = extras_require['examples'] + [
'nbsite >=0.8.4',
'sphinxext-rediraffe',
]

# until pyproject.toml/equivalent is widely supported (setup_requires
Expand Down
Loading