Skip to content

Various minor docs fixes #1084

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

Merged
merged 6 commits into from
Jun 12, 2023
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
3 changes: 2 additions & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
- uses: conda-incubator/setup-miniconda@v2
with:
mamba-version: "*"
channels: pyviz/label/dev,conda-forge,nodefaults
channels: pyviz/label/dev,conda-forge
- name: Fetch unshallow
run: git fetch --prune --tags --unshallow -f
- name: Set and echo git ref
Expand All @@ -50,6 +50,7 @@ jobs:
echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
- name: conda setup
run: |
conda config --remove channels defaults
conda create -n test-environment python=3.8 pyctdev
- name: doit develop_install
run: |
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ repos:
args: [hvplot]
files: hvplot/
- repo: https://github.com/hoxbro/clean_notebook
rev: v0.1.9
rev: v0.1.10
hooks:
- id: clean-notebook
4 changes: 4 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
'custom.css'
]

html_js_files = [
'https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js',
]

html_theme_options.update({
"github_url": "https://github.com/holoviz/hvplot",
"icon_links": [
Expand Down
1 change: 0 additions & 1 deletion examples/reference/pandas/hist.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand Down
22 changes: 22 additions & 0 deletions examples/user_guide/Plotting_Extensions.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "2ce662e1",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -11,6 +12,7 @@
},
{
"cell_type": "markdown",
"id": "bd615c60",
"metadata": {},
"source": [
"hvPlot allows to generate plots with three different plotting extensions: [Bokeh](https://docs.bokeh.org), [Matplotlib](https://matplotlib.org/) and [Plotly](https://plotly.com/). Support for Maplotlib and Plotly was added in version 0.8.0, before which Bokeh was the only option available and is as such kept as the default plotting extension.\n",
Expand All @@ -23,6 +25,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "78a9f5b8",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -32,6 +35,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "615a4574",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -41,6 +45,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "2d4aa473",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -49,6 +54,7 @@
},
{
"cell_type": "markdown",
"id": "9724c0af",
"metadata": {},
"source": [
"## Switching the plotting extension\n",
Expand All @@ -59,6 +65,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "66ba89b0",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -69,6 +76,7 @@
},
{
"cell_type": "markdown",
"id": "0111ae1a",
"metadata": {},
"source": [
"<div class=\"alert alert-warning\" role=\"alert\">\n",
Expand All @@ -78,6 +86,7 @@
},
{
"cell_type": "markdown",
"id": "20eb7da9",
"metadata": {},
"source": [
"## Plot styling options\n",
Expand All @@ -88,6 +97,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "0282171e",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -98,6 +108,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "6078c7ba",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -107,6 +118,7 @@
},
{
"cell_type": "markdown",
"id": "bcf1f408",
"metadata": {},
"source": [
"It is also possible to generates plots with either Matplotlib or Plotly that are constructed with Bokeh options. This can be used for instance to create plots previously generated with Bokeh with another backend, without having to change any parameter. The only change required is to declare Bokeh as the compatible extension with `hvplot.extension('matplotlib', compatibility='bokeh')`, preferably at the beginning of the notebook."
Expand All @@ -115,6 +127,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "21701d52",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -126,6 +139,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "1371e7df",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -134,20 +148,23 @@
},
{
"cell_type": "markdown",
"id": "96ed79b6",
"metadata": {},
"source": [
"You can see that `line_dash='dashed'` has been internally converted to `linestyle='dashed'` that is a valid option for the Matplotlib plotting extension. Note that support for all Bokeh options is currently incomplete and will continue to be improved while equivalent support for Plotly and Matplotlib is planned for a future release"
]
},
{
"cell_type": "markdown",
"id": "3ac83784",
"metadata": {},
"source": [
"## Obtaining the underlying figure object "
]
},
{
"cell_type": "markdown",
"id": "706832e4",
"metadata": {},
"source": [
"In some cases it can be convenient to construct a plot with hvPlot and then get a handle on the figure object of the underlying plotting library to further customize the plot or to embed it in some more complex application. The `render` function allows to get a handle on the figure object. The following examples show that it's possible to use the API of Bokeh, Matplotlib or Plotly to update the title of the `violent_crime` plot."
Expand All @@ -156,6 +173,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "c20891e6",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -165,6 +183,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "d2f09071",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -178,6 +197,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "5753ad3a",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -191,6 +211,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "3fbf40c6",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -203,6 +224,7 @@
},
{
"cell_type": "markdown",
"id": "fb4230a0",
"metadata": {},
"source": [
"As demonstrated on this page hvPlot offers you the ability to choose your favorite plotting extension among those supported by [HoloViews](https://holoviews.org/), on which hvPlot is built."
Expand Down