Skip to content

Commit dc0418a

Browse files
committed
feat: fixing some dangling references in doc/python example files
1 parent 6d2f32f commit dc0418a

File tree

1,453 files changed

+2257
-2257
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,453 files changed

+2257
-2257
lines changed

doc/python/2D-Histogram.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ jupyter:
3838

3939
## 2D Histograms or Density Heatmaps
4040

41-
A 2D histogram, also known as a density heatmap, is the 2-dimensional generalization of a [histogram](../histograms/) which resembles a [heatmap](../heatmaps/) but is computed by grouping a set of points specified by their `x` and `y` coordinates into bins, and applying an aggregation function such as `count` or `sum` (if `z` is provided) to compute the color of the tile representing the bin. This kind of visualization (and the related [2D histogram contour, or density contour](https://plotly.com/python/2d-histogram-contour/)) is often used to manage over-plotting, or situations where showing large data sets as [scatter plots](../line-and-scatter/) would result in points overlapping each other and hiding patterns. For data sets of more than a few thousand points, a better approach than the ones listed here would be to [use Plotly with Datashader](../datashader/) to precompute the aggregations before displaying the data with Plotly.
41+
A 2D histogram, also known as a density heatmap, is the 2-dimensional generalization of a [histogram](histograms.md) which resembles a [heatmap](heatmaps.md) but is computed by grouping a set of points specified by their `x` and `y` coordinates into bins, and applying an aggregation function such as `count` or `sum` (if `z` is provided) to compute the color of the tile representing the bin. This kind of visualization (and the related [2D histogram contour, or density contour](https://plotly.com/python/2d-histogram-contour/)) is often used to manage over-plotting, or situations where showing large data sets as [scatter plots](line-and-scatter.md) would result in points overlapping each other and hiding patterns. For data sets of more than a few thousand points, a better approach than the ones listed here would be to [use Plotly with Datashader](datashader.md) to precompute the aggregations before displaying the data with Plotly.
4242

4343
## Density Heatmaps with Plotly Express
4444

45-
[Plotly Express](../plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](../px-arguments/) and produces [easy-to-style figures](../styling-plotly-express/). The Plotly Express function `density_heatmap()` can be used to produce density heatmaps.
45+
[Plotly Express](plotly-express.md) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](px-arguments.md) and produces [easy-to-style figures](styling-plotly-express.md). The Plotly Express function `density_heatmap()` can be used to produce density heatmaps.
4646

4747
```python
4848
import plotly.express as px
@@ -52,7 +52,7 @@ fig = px.density_heatmap(df, x="total_bill", y="tip")
5252
fig.show()
5353
```
5454

55-
The number of bins can be controlled with `nbinsx` and `nbinsy` and the [color scale](../colorscales/) with `color_continuous_scale`.
55+
The number of bins can be controlled with `nbinsx` and `nbinsy` and the [color scale](colorscales.md) with `color_continuous_scale`.
5656

5757
```python
5858
import plotly.express as px
@@ -62,7 +62,7 @@ fig = px.density_heatmap(df, x="total_bill", y="tip", nbinsx=20, nbinsy=20, colo
6262
fig.show()
6363
```
6464

65-
Marginal plots can be added to visualize the 1-dimensional distributions of the two variables. Here we use a marginal [`histogram`](../histograms/). Other allowable values are `violin`, `box` and `rug`.
65+
Marginal plots can be added to visualize the 1-dimensional distributions of the two variables. Here we use a marginal [`histogram`](histograms.md). Other allowable values are `violin`, `box` and `rug`.
6666

6767
```python
6868
import plotly.express as px
@@ -72,7 +72,7 @@ fig = px.density_heatmap(df, x="total_bill", y="tip", marginal_x="histogram", ma
7272
fig.show()
7373
```
7474

75-
Density heatmaps can also be [faceted](../facet-plots/):
75+
Density heatmaps can also be [faceted](facet-plots.md):
7676

7777
```python
7878
import plotly.express as px
@@ -110,7 +110,7 @@ fig.show()
110110

111111
### 2D Histograms with Graph Objects
112112

113-
To build this kind of figure using [graph objects](../graph-objects/) without using Plotly Express, we can use the `go.Histogram2d` class.
113+
To build this kind of figure using [graph objects](graph-objects.md) without using Plotly Express, we can use the `go.Histogram2d` class.
114114

115115

116116
### 2D Histogram of a Bivariate Normal Distribution ###

doc/python/2d-histogram-contour.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ jupyter:
3636

3737
## 2D Histogram Contours or Density Contours
3838

39-
A 2D histogram contour plot, also known as a density contour plot, is a 2-dimensional generalization of a [histogram](../histograms/) which resembles a [contour plot](../contour-plots/) but is computed by grouping a set of points specified by their `x` and `y` coordinates into bins, and applying an aggregation function such as `count` or `sum` (if `z` is provided) to compute the value to be used to compute contours. This kind of visualization (and the related [2D histogram, or density heatmap](../2d-histogram/)) is often used to manage over-plotting, or situations where showing large data sets as [scatter plots](../line-and-scatter/) would result in points overlapping each other and hiding patterns.
39+
A 2D histogram contour plot, also known as a density contour plot, is a 2-dimensional generalization of a [histogram](histograms.md) which resembles a [contour plot](contour-plots.md) but is computed by grouping a set of points specified by their `x` and `y` coordinates into bins, and applying an aggregation function such as `count` or `sum` (if `z` is provided) to compute the value to be used to compute contours. This kind of visualization (and the related [2D histogram, or density heatmap](2D-Histogram.md)) is often used to manage over-plotting, or situations where showing large data sets as [scatter plots](line-and-scatter.md) would result in points overlapping each other and hiding patterns.
4040

4141
## Density Contours with Plotly Express
4242

43-
[Plotly Express](../plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](../px-arguments/) and produces [easy-to-style figures](../styling-plotly-express/). The Plotly Express function `density_contour()` can be used to produce density contours.
43+
[Plotly Express](plotly-express.md) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](px-arguments.md) and produces [easy-to-style figures](styling-plotly-express.md). The Plotly Express function `density_contour()` can be used to produce density contours.
4444

4545
```python
4646
import plotly.express as px
@@ -50,7 +50,7 @@ fig = px.density_contour(df, x="total_bill", y="tip")
5050
fig.show()
5151
```
5252

53-
Marginal plots can be added to visualize the 1-dimensional distributions of the two variables. Here we use a marginal [`histogram`](../histograms/). Other allowable values are `violin`, `box` and `rug`.
53+
Marginal plots can be added to visualize the 1-dimensional distributions of the two variables. Here we use a marginal [`histogram`](histograms.md). Other allowable values are `violin`, `box` and `rug`.
5454

5555
```python
5656
import plotly.express as px
@@ -60,7 +60,7 @@ fig = px.density_contour(df, x="total_bill", y="tip", marginal_x="histogram", ma
6060
fig.show()
6161
```
6262

63-
Density contours can also be [faceted](../facet-plots/) and [discretely colored](../discrete-color/):
63+
Density contours can also be [faceted](facet-plots.md) and [discretely colored](discrete-color.md):
6464

6565
```python
6666
import plotly.express as px
@@ -70,7 +70,7 @@ fig = px.density_contour(df, x="total_bill", y="tip", facet_col="sex", color="sm
7070
fig.show()
7171
```
7272

73-
Plotly Express density contours can be [continuously-colored](../colorscales/) and labeled:
73+
Plotly Express density contours can be [continuously-colored](colorscales.md) and labeled:
7474

7575
```python
7676
import plotly.express as px
@@ -95,7 +95,7 @@ fig.show()
9595

9696
### 2D Histograms with Graph Objects
9797

98-
To build this kind of figure with [graph objects](../graph-objects/) without using Plotly Express, we can use the `go.Histogram2d` class.
98+
To build this kind of figure with [graph objects](graph-objects.md) without using Plotly Express, we can use the `go.Histogram2d` class.
9999

100100
#### Basic 2D Histogram Contour
101101

doc/python/3d-scatter-plots.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jupyter:
3535

3636
## 3D scatter plot with Plotly Express
3737

38-
[Plotly Express](../plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](../px-arguments/) and produces [easy-to-style figures](../styling-plotly-express/).
38+
[Plotly Express](plotly-express.md) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](px-arguments.md) and produces [easy-to-style figures](styling-plotly-express.md).
3939

4040
Like the [2D scatter plot](https://plotly.com/python/line-and-scatter/) `px.scatter`, the 3D function `px.scatter_3d` plots individual data in three-dimensional space.
4141

@@ -94,7 +94,7 @@ IFrame(snippet_url + '3d-scatter-plots', width='100%', height=1200)
9494

9595
#### Basic 3D Scatter Plot
9696

97-
If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Scatter3D` class from `plotly.graph_objects`](../graph-objects/).
97+
If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Scatter3D` class from `plotly.graph_objects`](graph-objects.md).
9898
Like the [2D scatter plot](https://plotly.com/python/line-and-scatter/) `go.Scatter`, `go.Scatter3d` plots individual data in three-dimensional space.
9999

100100
```python

doc/python/3d-volume.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jupyter:
3333
thumbnail: thumbnail/3d-volume-plots.jpg
3434
---
3535

36-
A volume plot with `go.Volume` shows several partially transparent isosurfaces for volume rendering. The API of `go.Volume` is close to the one of `go.Isosurface`. However, whereas [isosurface plots](../3d-isosurface-plots/) show all surfaces with the same opacity, tweaking the `opacityscale` parameter of `go.Volume` results in a depth effect and better volume rendering.
36+
A volume plot with `go.Volume` shows several partially transparent isosurfaces for volume rendering. The API of `go.Volume` is close to the one of `go.Isosurface`. However, whereas [isosurface plots](3d-isosurface-plots.md) show all surfaces with the same opacity, tweaking the `opacityscale` parameter of `go.Volume` results in a depth effect and better volume rendering.
3737

3838
## Simple volume plot with go.Volume
3939

@@ -257,4 +257,4 @@ fig.show()
257257
See https://plotly.com/python/reference/volume/ for more information and chart attribute options!
258258

259259
#### See also
260-
[3D isosurface documentation](../3d-isosurface-plots/)
260+
[3D isosurface documentation](3d-isosurface-plots.md)

doc/python/animations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jupyter:
3636

3737
#### Animated figures with Plotly Express
3838

39-
Several [Plotly Express](../plotly-express/) functions support the creation of animated figures through the `animation_frame` and `animation_group` arguments.
39+
Several [Plotly Express](plotly-express.md) functions support the creation of animated figures through the `animation_frame` and `animation_group` arguments.
4040

4141
Here is an example of an animated scatter plot created with Plotly Express. Note that you should always fix the `x_range` and `y_range` to ensure that your data remains visible throughout the animation.
4242

@@ -83,7 +83,7 @@ fig.show()
8383

8484
#### Animated figures with Graph Objects
8585

86-
The remainder of this section describes the low-level [graph objects](../graph-objects/) API for constructing animated figures manually.
86+
The remainder of this section describes the low-level [graph objects](graph-objects.md) API for constructing animated figures manually.
8787

8888
#### Frames
8989

doc/python/annotated-heatmap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jupyter:
3838

3939
*New in v5.5*
4040

41-
As of version 5.5.0 of `plotly`, the **recommended way to [display annotated heatmaps is to use `px.imshow()`](../heatmaps/)** rather than the now-deprecated `create_annotated_heatmap` figure factory documented below for historical reasons.
41+
As of version 5.5.0 of `plotly`, the **recommended way to [display annotated heatmaps is to use `px.imshow()`](heatmaps.md)** rather than the now-deprecated `create_annotated_heatmap` figure factory documented below for historical reasons.
4242

4343

4444
#### Basic Annotated Heatmap for z-annotations
@@ -62,7 +62,7 @@ fig.show()
6262

6363
### Deprecated Figure Factory
6464

65-
The remaining examples show how to create Annotated Heatmaps with the deprecated `create_annotated_heatmap` [figure factory](../figure-factories/).
65+
The remaining examples show how to create Annotated Heatmaps with the deprecated `create_annotated_heatmap` [figure factory](figure-factories.md).
6666

6767

6868
#### Simple Annotated Heatmap

doc/python/axes.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,30 @@ jupyter:
3333
thumbnail: thumbnail/axes.png
3434
---
3535

36-
This tutorial explain how to set the properties of [2-dimensional Cartesian axes](../figure-structure/#2d-cartesian-trace-types-and-subplots), namely [`go.layout.XAxis`](../reference/layout/xaxis/) and [`go.layout.YAxis`](../reference/layout/xaxis/).
36+
This tutorial explain how to set the properties of [2-dimensional Cartesian axes](figure-structure.md#2d-cartesian-trace-types-and-subplots), namely [`go.layout.XAxis`](/reference/layout/xaxis.md) and [`go.layout.YAxis`](/reference/layout/xaxis.md).
3737

3838
Other kinds of subplots and axes are described in other tutorials:
3939

40-
- [3D axes](../3d-axes) The axis object is [`go.layout.Scene`](../reference/layout/scene/)
41-
- [Polar axes](../polar-chart/). The axis object is [`go.layout.Polar`](../reference/layout/polar/)
42-
- [Ternary axes](../ternary-plots). The axis object is [`go.layout.Ternary`](../reference/layout/ternary/)
43-
- [Geo axes](../map-configuration/). The axis object is [`go.layout.Geo`](../reference/layout/geo/)
44-
- [Map axes](../tile-map-layers/). The axis object is [`go.layout.Map`](../reference/layout/map/)
45-
- [Color axes](../colorscales/). The axis object is [`go.layout.Coloraxis`](../reference/layout/coloraxis/).
40+
- [3D axes](3d-axes.md) The axis object is [`go.layout.Scene`](/reference/layout/scene.md)
41+
- [Polar axes](polar-chart.md). The axis object is [`go.layout.Polar`](/reference/layout/polar.md)
42+
- [Ternary axes](ternary-plots.md). The axis object is [`go.layout.Ternary`](/reference/layout/ternary.md)
43+
- [Geo axes](map-configuration.md). The axis object is [`go.layout.Geo`](/reference/layout/geo.md)
44+
- [Map axes](tile-map-layers.md). The axis object is [`go.layout.Map`](/reference/layout/map.md)
45+
- [Color axes](colorscales.md). The axis object is [`go.layout.Coloraxis`](/reference/layout/coloraxis.md).
4646

47-
**See also** the tutorials on [facet plots](../facet-plots/), [subplots](../subplots) and [multiple axes](../multiple-axes/).
47+
**See also** the tutorials on [facet plots](facet-plots.md), [subplots](subplots.md) and [multiple axes](multiple-axes.md).
4848

4949
### 2-D Cartesian Axis Types and Auto-Detection
5050

5151
The different types of Cartesian axes are configured via the `xaxis.type` or `yaxis.type` attribute, which can take on the following values:
5252

5353
- `'linear'` as described in this page
54-
- `'log'` (see the [log plot tutorial](../log-plot/))
55-
- `'date'` (see the [tutorial on timeseries](../time-series/))
56-
- `'category'` (see the [categorical axes tutorial](../categorical-axes/))
57-
- `'multicategory'` (see the [categorical axes tutorial](../categorical-axes/))
54+
- `'log'` (see the [log plot tutorial](log-plot.md))
55+
- `'date'` (see the [tutorial on timeseries](time-series.md))
56+
- `'category'` (see the [categorical axes tutorial](categorical-axes.md))
57+
- `'multicategory'` (see the [categorical axes tutorial](categorical-axes.md))
5858

59-
The axis type is auto-detected by looking at data from the first [trace](../figure-structure/) linked to this axis:
59+
The axis type is auto-detected by looking at data from the first [trace](figure-structure.md) linked to this axis:
6060

6161
* First check for `multicategory`, then `date`, then `category`, else default to `linear` (`log` is never automatically selected)
6262
* `multicategory` is just a shape test: is the array nested?
@@ -86,14 +86,14 @@ The different groups of Cartesian axes properties are
8686
- range of the axis
8787
- domain of the axis
8888

89-
The examples on this page apply to axes of any type, but extra attributes are available for [axes of type `category`](../categorical-axes/) and [axes of type `date`](../time-series/).
89+
The examples on this page apply to axes of any type, but extra attributes are available for [axes of type `category`](categorical-axes.md) and [axes of type `date`](time-series.md).
9090

9191

9292
#### Set and Style Axes Title Labels
9393

9494
##### Set axis title text with Plotly Express
9595

96-
Axis titles are automatically set to the column names when [using Plotly Express with a data frame as input](../px-arguments/).
96+
Axis titles are automatically set to the column names when [using Plotly Express with a data frame as input](px-arguments.md).
9797

9898
```python
9999
import plotly.express as px
@@ -102,7 +102,7 @@ fig = px.scatter(df, x="total_bill", y="tip", color="sex")
102102
fig.show()
103103
```
104104

105-
Axis titles (and [legend titles](../legend/)) can also be overridden using the `labels` argument of Plotly Express functions:
105+
Axis titles (and [legend titles](legend.md)) can also be overridden using the `labels` argument of Plotly Express functions:
106106

107107
```python
108108
import plotly.express as px

0 commit comments

Comments
 (0)