Skip to content

Commit 561570f

Browse files
merging doc-prod to master
2 parents 94a01ea + a4b600d commit 561570f

File tree

120 files changed

+519
-277
lines changed

Some content is hidden

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

120 files changed

+519
-277
lines changed

Diff for: .circleci/create_conda_optional_env.sh

+4
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,9 @@ if [ ! -d $HOME/miniconda/envs/circle_optional ]; then
1919
requests nbformat six retrying psutil pandas decorator pytest mock nose poppler xarray scikit-image ipython jupyter ipykernel ipywidgets
2020

2121
# Install orca into environment
22+
<<<<<<< HEAD
2223
$HOME/miniconda/bin/conda install --yes -n circle_optional -c plotly plotly-orca==1.3.1
24+
=======
25+
$HOME/miniconda/bin/conda install --yes -n circle_optional -c plotly plotly-orca==1.2.1
26+
>>>>>>> doc-prod
2327
fi

Diff for: binder/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ networkx
1414
scikit-image
1515
datashader
1616
pyarrow
17+
cufflinks==0.17.3

Diff for: doc/Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ $(IPYNB_FILES): $(IPYNB_DIR)/.mapbox_token
3030
$(IPYNB_DIR)/%.ipynb: $(MD_DIR)/%.md
3131
@mkdir -p $(IPYNB_DIR)
3232
@echo "[jupytext] $<"
33+
@cat what_about_dash.md >> $<
3334
@jupytext $< --to notebook --quiet --output $@
3435

3536
$(HTML_DIR)/2019-07-03-%.html: $(IPYNB_DIR)/%.ipynb

Diff for: doc/python/2D-Histogram.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ fig = go.Figure(go.Histogram2d(x=x, y=y, histnorm='probability',
7171
fig.show()
7272
```
7373
### Sharing bin settings between 2D Histograms
74-
This example shows how to use [bingroup](https://plot.ly/python/reference/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plot.ly/python/reference/#histogram2dcontour-ybins) and `xbins`.
74+
This example shows how to use [bingroup](https://plotly.com/python/reference/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plotly.com/python/reference/#histogram2dcontour-ybins) and `xbins`.
7575

7676
```python
7777
import plotly.graph_objects as go
@@ -170,4 +170,4 @@ fig.show()
170170
```
171171

172172
#### Reference
173-
See https://plot.ly/python/reference/#histogram2d for more information and chart attribute options!
173+
See https://plotly.com/python/reference/#histogram2d for more information and chart attribute options!

Diff for: doc/python/2d-histogram-contour.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -185,4 +185,4 @@ fig.show()
185185
```
186186

187187
#### Reference
188-
See https://plot.ly/python/reference/#histogram2dcontour for more information and chart attribute options!
188+
See https://plotly.com/python/reference/#histogram2dcontour for more information and chart attribute options!

Diff for: doc/python/3d-axes.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jupyter:
3939
attributes such as `xaxis`, `yaxis` and `zaxis` parameters, in order to
4040
set the range, title, ticks, color etc. of the axes.
4141

42-
For creating 3D charts, see [this page](https://plot.ly/python/3d-charts/).
42+
For creating 3D charts, see [this page](https://plotly.com/python/3d-charts/).
4343

4444
```python
4545
import plotly.graph_objects as go
@@ -141,7 +141,7 @@ fig.show()
141141
import plotly.graph_objects as go
142142
import numpy as np
143143

144-
# Define random surface
144+
# Define random surface
145145
N = 50
146146
fig = go.Figure(data=[go.Mesh3d(x=(60*np.random.randn(N)),
147147
y=(25*np.random.randn(N)),
@@ -150,7 +150,7 @@ fig = go.Figure(data=[go.Mesh3d(x=(60*np.random.randn(N)),
150150
color='rgba(100,22,200,0.5)'
151151
)])
152152

153-
# Different types of customized ticks
153+
# Different types of customized ticks
154154
fig.update_layout(scene = dict(
155155
xaxis = dict(
156156
ticktext= ['TICKS','MESH','PLOTLY','PYTHON'],
@@ -184,7 +184,7 @@ fig = go.Figure(data=[go.Mesh3d(x=(30*np.random.randn(N)),
184184
opacity=0.5,)])
185185

186186

187-
# xaxis.backgroundcolor is used to set background color
187+
# xaxis.backgroundcolor is used to set background color
188188
fig.update_layout(scene = dict(
189189
xaxis = dict(
190190
backgroundcolor="rgb(200, 200, 230)",

Diff for: doc/python/3d-bubble-charts.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ fig = go.Figure(data=go.Scatter3d(
108108
mode = 'markers',
109109
marker = dict(
110110
sizemode = 'diameter',
111-
sizeref = 750, # info on sizeref: https://plot.ly/python/reference/#scatter-marker-sizeref
111+
sizeref = 750, # info on sizeref: https://plotly.com/python/reference/#scatter-marker-sizeref
112112
size = planet_diameter,
113113
color = planet_colors,
114114
)
@@ -147,7 +147,7 @@ fig = go.Figure(go.Scatter3d(
147147
mode = 'markers',
148148
marker = dict(
149149
sizemode = 'diameter',
150-
sizeref = 750, # info on sizeref: https://plot.ly/python/reference/#scatter-marker-sizeref
150+
sizeref = 750, # info on sizeref: https://plotly.com/python/reference/#scatter-marker-sizeref
151151
size = planet_diameter,
152152
color = temperatures,
153153
colorbar_title = 'Mean<br>Temperature',
@@ -167,4 +167,4 @@ fig.show()
167167

168168
#### Reference
169169

170-
See https://plot.ly/python/reference/#scatter3d and https://plot.ly/python/reference/#scatter-marker-sizeref <br>for more information and chart attribute options!
170+
See https://plotly.com/python/reference/#scatter3d and https://plotly.com/python/reference/#scatter-marker-sizeref <br>for more information and chart attribute options!

Diff for: doc/python/3d-camera-controls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -290,4 +290,4 @@ fig.show()
290290
#### Reference
291291

292292

293-
See https://plot.ly/python/reference/#layout-scene-camera for more information and chart attribute options!
293+
See https://plotly.com/python/reference/#layout-scene-camera for more information and chart attribute options!

Diff for: doc/python/3d-isosurface-plots.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,5 +235,5 @@ fig.show()
235235
```
236236

237237
#### Reference
238-
See https://plot.ly/python/reference/#isosurface for more information and chart attribute options!
238+
See https://plotly.com/python/reference/#isosurface for more information and chart attribute options!
239239

Diff for: doc/python/3d-line-plots.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,4 @@ fig.show()
120120

121121
#### Reference
122122

123-
See https://plot.ly/python/reference/#scatter3d-marker-line for more information and chart attribute options!
123+
See https://plotly.com/python/reference/#scatter3d-marker-line for more information and chart attribute options!

Diff for: doc/python/3d-mesh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,4 +163,4 @@ fig.show()
163163
```
164164

165165
## Reference
166-
See https://plot.ly/python/reference/#mesh3d for more information and chart attribute options!
166+
See https://plotly.com/python/reference/#mesh3d for more information and chart attribute options!

Diff for: doc/python/3d-scatter-plots.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jupyter:
3737

3838
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on "tidy" data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
3939

40-
Like the [2D scatter plot](https://plot.ly/python/line-and-scatter/) `px.scatter`, the 3D function `px.scatter_3d` plots individual data in three-dimensional space.
40+
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

4242
```python
4343
import plotly.express as px
@@ -77,7 +77,7 @@ fig.update_layout(margin=dict(l=0, r=0, b=0, t=0))
7777
#### Basic 3D Scatter Plot
7878

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

8282
```python
8383
import plotly.graph_objects as go
@@ -122,7 +122,7 @@ fig.show()
122122

123123
### Dash App
124124

125-
[Dash](https://plot.ly/products/dash/) is an Open Source Python library which can help you convert plotly figures into a reactive, web-based application. Below is a simple example of a dashboard created using Dash. Its [source code](https://github.com/plotly/simple-example-chart-apps/tree/master/dash-3dscatterplot) can easily be deployed to a PaaS.
125+
[Dash](https://plotly.com/products/dash/) is an Open Source Python library which can help you convert plotly figures into a reactive, web-based application. Below is a simple example of a dashboard created using Dash. Its [source code](https://github.com/plotly/simple-example-chart-apps/tree/master/dash-3dscatterplot) can easily be deployed to a PaaS.
126126

127127
```python
128128
from IPython.display import IFrame
@@ -136,4 +136,4 @@ IFrame(src= "https://dash-simple-apps.plotly.host/dash-3dscatterplot/code", widt
136136

137137
#### Reference
138138

139-
See https://plot.ly/python/reference/#scatter3d for more information and chart attribute options!
139+
See https://plotly.com/python/reference/#scatter3d for more information and chart attribute options!

Diff for: doc/python/3d-subplots.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ fig.show()
8282
#### Reference
8383

8484

85-
See https://plot.ly/python/subplots/ for more information regarding subplots!
85+
See https://plotly.com/python/subplots/ for more information regarding subplots!

Diff for: doc/python/3d-surface-coloring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ fig.show()
6060
#### Reference
6161

6262

63-
See https://plot.ly/python/reference/#surface-surfacecolor for more information!
63+
See https://plotly.com/python/reference/#surface-surfacecolor for more information!
6464

Diff for: doc/python/3d-surface-plots.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ fig.show()
7676
#### Surface Plot With Contours
7777

7878

79-
Display and customize contour data for each axis using the `contours` attribute ([reference](plot.ly/python/reference/#surface-contours)).
79+
Display and customize contour data for each axis using the `contours` attribute ([reference](plotly.com/python/reference/#surface-contours)).
8080

8181
```python
8282
import plotly.graph_objects as go
@@ -98,7 +98,7 @@ fig.update_layout(title='Mt Bruno Elevation', autosize=False,
9898
fig.show()
9999
```
100100
#### Configure Surface Contour Levels
101-
This example shows how to slice the surface graph on the desired position for each of x, y and z axis. [contours.x.start](https://plot.ly/python/reference/#surface-contours-x-start) sets the starting contour level value, `end` sets the end of it, and `size` sets the step between each contour level.
101+
This example shows how to slice the surface graph on the desired position for each of x, y and z axis. [contours.x.start](https://plotly.com/python/reference/#surface-contours-x-start) sets the starting contour level value, `end` sets the end of it, and `size` sets the step between each contour level.
102102

103103
```python
104104
import plotly.graph_objects as go
@@ -166,4 +166,4 @@ fig.show()
166166
#### Reference
167167

168168

169-
See https://plot.ly/python/reference/#surface for more information!
169+
See https://plotly.com/python/reference/#surface for more information!

Diff for: doc/python/3d-volume.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ fig = go.Figure(data=go.Volume(
190190
))
191191

192192
# Change camera view for a better view of the sides, XZ plane
193-
# (see https://plot.ly/python/v3/3d-camera-controls/)
193+
# (see https://plotly.com/python/v3/3d-camera-controls/)
194194
fig.update_layout(scene_camera = dict(
195195
up=dict(x=0, y=0, z=1),
196196
center=dict(x=0, y=0, z=0),
@@ -254,7 +254,7 @@ fig.show()
254254
```
255255

256256
#### Reference
257-
See https://plot.ly/python/reference/#volume for more information and chart attribute options!
257+
See https://plotly.com/python/reference/#volume for more information and chart attribute options!
258258

259259
#### See also
260260
[3D isosurface documentation](/python/3d-isosurface-plots/)

Diff for: doc/python/aggregations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ import plotly.io as pio
142142

143143
import pandas as pd
144144

145-
df = pd.read_csv("https://plot.ly/~public.health/17.csv")
145+
df = pd.read_csv("https://plotly.com/~public.health/17.csv")
146146

147147
data = [dict(
148148
x = df['date'],
@@ -270,4 +270,4 @@ pio.show(fig_dict, validate=False)
270270
```
271271

272272
#### Reference
273-
See https://plot.ly/python/reference/ for more information and chart attribute options!
273+
See https://plotly.com/python/reference/ for more information and chart attribute options!

Diff for: doc/python/animations.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Along with `data` and `layout`, `frames` can be added as a key in a figure objec
6363

6464
#### Adding Control Buttons to Animations
6565

66-
You can add play and pause buttons to control your animated charts by adding an `updatemenus` array to the `layout` of your `figure`. More information on style and placement of the buttons is available in Plotly's [`updatemenus` reference](https://plot.ly/python/reference/#layout-updatemenus).
66+
You can add play and pause buttons to control your animated charts by adding an `updatemenus` array to the `layout` of your `figure`. More information on style and placement of the buttons is available in Plotly's [`updatemenus` reference](https://plotly.com/python/reference/#layout-updatemenus).
6767
<br>
6868
The buttons are defined as follows:
6969

@@ -389,5 +389,5 @@ fig.show()
389389

390390
#### Reference
391391

392-
For additional information and attributes for creating bubble charts in Plotly see: https://plot.ly/python/bubble-charts/.
393-
For more documentation on creating animations with Plotly, see https://plot.ly/python/#animations.
392+
For additional information and attributes for creating bubble charts in Plotly see: https://plotly.com/python/bubble-charts/.
393+
For more documentation on creating animations with Plotly, see https://plotly.com/python/#animations.

Diff for: doc/python/annotated-heatmap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ fig.show()
202202
```
203203

204204
#### Reference
205-
For more info on Plotly heatmaps, see: https://plot.ly/python/reference/#heatmap.<br> For more info on using colorscales with Plotly see: https://plot.ly/python/heatmap-and-contour-colorscales/ <br>For more info on annotated_heatmaps, see:
205+
For more info on Plotly heatmaps, see: https://plotly.com/python/reference/#heatmap.<br> For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/ <br>For more info on annotated_heatmaps, see:
206206

207207
```python
208208
help(ff.create_annotated_heatmap)

Diff for: doc/python/axes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ fig.show()
477477

478478
### Set axis title position
479479

480-
This example sets `standoff` attribute to cartesian axes to determine the distance between the tick labels and the axis title. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By default [automargin](https://plot.ly/python/setting-graph-size/#automatically-adjust-margins) is `True` in Plotly template for the cartesian axis, so the margins will be pushed to fit the axis title at given standoff distance.
480+
This example sets `standoff` attribute to cartesian axes to determine the distance between the tick labels and the axis title. Note that the axis title position is always constrained within the margins, so the actual standoff distance is always less than the set or default value. By default [automargin](https://plotly.com/python/setting-graph-size/#automatically-adjust-margins) is `True` in Plotly template for the cartesian axis, so the margins will be pushed to fit the axis title at given standoff distance.
481481

482482
```python
483483
import plotly.graph_objects as go
@@ -743,7 +743,7 @@ fig.show()
743743

744744
#### Synchronizing axes in subplots with `matches`
745745

746-
Using `facet_col` from `plotly.express` let [zoom](https://help.plot.ly/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plot.ly/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
746+
Using `facet_col` from `plotly.express` let [zoom](https://help.plotly.com/zoom-pan-hover-controls/#step-3-zoom-in-and-zoom-out-autoscale-the-plot) and [pan](https://help.plotly.com/zoom-pan-hover-controls/#step-6-pan-along-axes) each facet to the same range implicitly. However, if the subplots are created with `make_subplots`, the axis needs to be updated with `matches` parameter to update all the subplots accordingly.
747747

748748
Zoom in one trace below, to see the other subplots zoomed to the same x-axis range. To pan all the subplots, click and drag from the center of x-axis to the side:
749749

@@ -764,4 +764,4 @@ fig.show()
764764

765765
#### Reference
766766

767-
See https://plot.ly/python/reference/#layout-xaxis and https://plot.ly/python/reference/#layout-yaxis for more information and chart attribute options!
767+
See https://plotly.com/python/reference/#layout-xaxis and https://plotly.com/python/reference/#layout-yaxis for more information and chart attribute options!

Diff for: doc/python/bar-charts.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ fig.show()
5050
data_canada
5151
```
5252

53-
### Customize bar chart with Plotly Express
53+
### Customize bar chart with Plotly Express
5454

5555
The bar plot can be customized using keyword arguments.
5656

@@ -121,7 +121,7 @@ fig = go.Figure(data=[
121121
go.Bar(name='SF Zoo', x=animals, y=[20, 14, 23]),
122122
go.Bar(name='LA Zoo', x=animals, y=[12, 18, 29])
123123
])
124-
# Change the bar mode
124+
# Change the bar mode
125125
fig.update_layout(barmode='group')
126126
fig.show()
127127
```
@@ -213,7 +213,7 @@ fig.add_trace(go.Bar(
213213
marker_color='lightsalmon'
214214
))
215215

216-
# Here we modify the tickangle of the xaxis, resulting in rotated labels.
216+
# Here we modify the tickangle of the xaxis, resulting in rotated labels.
217217
fig.update_layout(barmode='group', xaxis_tickangle=-45)
218218
fig.show()
219219
```
@@ -336,7 +336,7 @@ fig.show()
336336

337337
### Bar Chart with Sorted or Ordered Categories
338338

339-
Set `categoryorder` to `"category ascending"` or `"category descending"` for the alphanumerical order of the category names or `"total ascending"` or `"total descending"` for numerical order of values. [categoryorder](https://plot.ly/python/reference/#layout-xaxis-categoryorder) for more information. Note that sorting the bars by a particular trace isn't possible right now - it's only possible to sort by the total values. Of course, you can always sort your data _before_ plotting it if you need more customization.
339+
Set `categoryorder` to `"category ascending"` or `"category descending"` for the alphanumerical order of the category names or `"total ascending"` or `"total descending"` for numerical order of values. [categoryorder](https://plotly.com/python/reference/#layout-xaxis-categoryorder) for more information. Note that sorting the bars by a particular trace isn't possible right now - it's only possible to sort by the total values. Of course, you can always sort your data _before_ plotting it if you need more customization.
340340

341341
This example orders the bar chart alphabetically with `categoryorder: 'category ascending'`
342342

@@ -382,8 +382,8 @@ fig.show()
382382

383383
### Horizontal Bar Charts
384384

385-
See examples of horizontal bar charts [here](https://plot.ly/python/horizontal-bar-charts/).
385+
See examples of horizontal bar charts [here](https://plotly.com/python/horizontal-bar-charts/).
386386

387387
### Reference
388388

389-
See https://plot.ly/python/reference/#bar for more information and chart attribute options!
389+
See https://plotly.com/python/reference/#bar for more information and chart attribute options!

Diff for: doc/python/box-plots.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jupyter:
3636
thumbnail: thumbnail/box.jpg
3737
---
3838

39-
A [box plot](https://en.wikipedia.org/wiki/Box_plot) is a statistical representation of numerical data through their quartiles. The ends of the box represent the lower and upper quartiles, while the median (second quartile) is marked by a line inside the box. For other statistical representations of numerical data, see [other statistical charts](https://plot.ly/python/statistical-charts/).
39+
A [box plot](https://en.wikipedia.org/wiki/Box_plot) is a statistical representation of numerical data through their quartiles. The ends of the box represent the lower and upper quartiles, while the median (second quartile) is marked by a line inside the box. For other statistical representations of numerical data, see [other statistical charts](https://plotly.com/python/statistical-charts/).
4040

4141
## Box Plot with `plotly.express`
4242

@@ -134,7 +134,7 @@ fig.show()
134134

135135
## Box plot with go.Box
136136

137-
If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Box` function from `plotly.graph_objects`. All available options for `go.Box` are described in the reference page https://plot.ly/python/reference/#box.
137+
If Plotly Express does not provide a good starting point, it is also possible to use the more generic `go.Box` function from `plotly.graph_objects`. All available options for `go.Box` are described in the reference page https://plotly.com/python/reference/#box.
138138

139139
### Basic Box Plot
140140

@@ -280,7 +280,7 @@ fig.add_trace(go.Box(
280280
name="All Points",
281281
jitter=0.3,
282282
pointpos=-1.8,
283-
boxpoints='all', # represent all points
283+
boxpoints='all', # represent all points
284284
marker_color='rgb(7,40,89)',
285285
line_color='rgb(7,40,89)'
286286
))
@@ -353,7 +353,7 @@ fig.add_trace(go.Box(
353353

354354
fig.update_layout(
355355
yaxis_title='normalized moisture',
356-
boxmode='group' # group together boxes of the different traces for each value of x
356+
boxmode='group' # group together boxes of the different traces for each value of x
357357
)
358358
fig.show()
359359
```
@@ -491,4 +491,4 @@ fig.show()
491491

492492
#### Reference
493493

494-
See https://plot.ly/python/reference/#box for more information and chart attribute options!
494+
See https://plotly.com/python/reference/#box for more information and chart attribute options!

0 commit comments

Comments
 (0)