Skip to content

Commit bf78a8a

Browse files
authored
Merge pull request #4683 from plotly/add-latest-docs-updates
Add latest docs updates to master
2 parents 9b5ec6a + a32a981 commit bf78a8a

10 files changed

+15
-13
lines changed

Diff for: doc/apidoc/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ help:
3636
# Remove files which were added only for docstring generation
3737
rm ../../packages/python/plotly/plotly/colors/diverging.py ../../packages/python/plotly/plotly/colors/sequential.py ../../packages/python/plotly/plotly/colors/qualitative.py ../../packages/python/plotly/plotly/colors/cyclical.py ../../packages/python/plotly/plotly/colors/colorbrewer.py ../../packages/python/plotly/plotly/colors/carto.py ../../packages/python/plotly/plotly/colors/cmocean.py
3838
rm ../../packages/python/plotly/plotly/express/colors/diverging.py ../../packages/python/plotly/plotly/express/colors/sequential.py ../../packages/python/plotly/plotly/express/colors/qualitative.py ../../packages/python/plotly/plotly/express/colors/cyclical.py ../../packages/python/plotly/plotly/express/colors/colorbrewer.py ../../packages/python/plotly/plotly/express/colors/carto.py ../../packages/python/plotly/plotly/express/colors/cmocean.py
39-
rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html
39+
rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html _build/html/generated/generated/*.html
4040
mv _build/html/generated/plotly.graph_objs.html _build/html/generated/plotly.graph_objects.html
4141
sed -i 's/graph_objs/graph_objects/g' _build/html/*.html
4242
sed -i 's/graph_objs/graph_objects/g' _build/html/*.inv

Diff for: doc/python/configuration-options.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ fig.show()
252252

253253
*New in v4.7*
254254

255-
Some modebar buttons of Cartesian plots are optional and have to be added explicitly, using the `modeBarButtonsToAdd` config attribute. These buttons are used for drawing or erasing shapes. See [the tutorial on shapes and shape drawing](python/shapes#drawing-shapes-on-cartesian-plots) for more details.
255+
Some modebar buttons of Cartesian plots are optional and have to be added explicitly, using the `modeBarButtonsToAdd` config attribute. These buttons are used for drawing or erasing shapes. See [the tutorial on shapes and shape drawing](/python/shapes#drawing-shapes-with-a-mouse-on-cartesian-plots) for more details.
256256

257257
```python
258258
import plotly.express as px

Diff for: doc/python/multiple-axes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ fig.show()
357357

358358
*New in 5.13*
359359

360-
With overlayed axes, each axis by default has its own number of ticks. You can sync the number of ticks on a cartesian axis with another one it overlays by setting `tickmode="sync"`. In this example, we sync the ticks on the `"Total bill amount"` axis with the `"Total number of diners"` axis that it overlays.
360+
With overlayed axes, each axis by default has its own number of ticks. You can sync the number of ticks on a cartesian axis with another one it overlays by setting `tickmode="sync"`. In this example, we sync the ticks on the `"Total bill amount"` axis with the `"Total number of diners"` axis that it overlays.
361361

362362
```python
363363
import plotly.graph_objects as go
@@ -415,4 +415,4 @@ fig.show()
415415
```
416416

417417
#### Reference
418-
All of the y-axis properties are found here: https://plotly.com/python/reference/YAxis/. For more information on creating subplots see the [Subplots in Python](/python/subplots/) section.
418+
All of the y-axis properties are found here: https://plotly.com/python/reference/layout/yaxis/. For more information on creating subplots see the [Subplots in Python](/python/subplots/) section.

Diff for: doc/python/network-graphs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ fig = go.Figure(data=[edge_trace, node_trace],
134134
hovermode='closest',
135135
margin=dict(b=20,l=5,r=5,t=40),
136136
annotations=[ dict(
137-
text="Python code: <a href='https://plotly.com/ipython-notebooks/network-graphs/'> https://plotly.com/ipython-notebooks/network-graphs/</a>",
137+
text="Python code: <a href='https://plotly.com/python/network-graphs/'> https://plotly.com/python/network-graphs/</a>",
138138
showarrow=False,
139139
xref="paper", yref="paper",
140140
x=0.005, y=-0.002 ) ],

Diff for: doc/python/peak-finding.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jupyter:
3636

3737
#### Imports
3838

39-
The tutorial below imports [Pandas](https://plotly.com/pandas/intro-to-pandas-tutorial/), and [SciPy](https://www.scipy.org/).
39+
The tutorial below imports [Pandas](https://pandas.pydata.org/docs/user_guide/10min.html), and [SciPy](https://www.scipy.org/).
4040

4141
```python
4242
import pandas as pd

Diff for: doc/python/smoothing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jupyter:
3636

3737
#### Imports
3838

39-
The tutorial below imports [NumPy](http://www.numpy.org/), [Pandas](https://plotly.com/pandas/intro-to-pandas-tutorial/), [SciPy](https://www.scipy.org/) and [Plotly](https://plotly.com/python/getting-started/).
39+
The tutorial below imports [NumPy](http://www.numpy.org/), [Pandas](https://pandas.pydata.org/docs/user_guide/10min.html), [SciPy](https://www.scipy.org/) and [Plotly](https://plotly.com/python/getting-started/).
4040

4141
```python
4242
import plotly.graph_objects as go

Diff for: doc/python/static-image-export.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ if not os.path.exists("images"):
101101
os.mkdir("images")
102102
```
103103

104-
If you are running this notebook live, click to [open the output directory](./images) so you can examine the images as they are written.
104+
If you are running this notebook live, click to open the output directory so you can examine the images as they are written.
105105

106106

107107
#### Raster Formats: PNG, JPEG, and WebP

Diff for: doc/python/subplots.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,8 @@ fig = make_subplots(2, 3, horizontal_spacing=0.1)
619619
```
620620

621621
#### Reference
622-
All of the x-axis properties are found here: https://plotly.com/python/reference/XAxis/
623-
All of the y-axis properties are found here: https://plotly.com/python/reference/YAxis/
622+
All of the x-axis properties are found here: https://plotly.com/python/reference/layout/xaxis/
623+
All of the y-axis properties are found here: https://plotly.com/python/reference/layout/yaxis/
624624

625625
```python
626626
from plotly.subplots import make_subplots

Diff for: doc/python/text-and-annotations.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ IFrame(snippet_url + 'text-and-annotations', width='100%', height=1200)
122122

123123
### Controlling Text Size with `uniformtext`
124124

125-
For the [pie](/python/pie-charts), [bar](/python/bar-charts)-like, [sunburst](/python/sunburst-charts) and [treemap](/python/treemap-charts) traces, it is possible to force all the text labels to have the same size thanks to the `uniformtext` layout parameter. The `minsize` attribute sets the font size, and the `mode` attribute sets what happens for labels which cannot fit with the desired fontsize: either `hide` them or `show` them with overflow.
125+
For the [pie](/python/pie-charts), [bar](/python/bar-charts)-like, [sunburst](/python/sunburst-charts) and [treemap](/python/treemaps) traces, it is possible to force all the text labels to have the same size thanks to the `uniformtext` layout parameter. The `minsize` attribute sets the font size, and the `mode` attribute sets what happens for labels which cannot fit with the desired fontsize: either `hide` them or `show` them with overflow.
126126

127127

128128
Here is a bar chart with the default behavior which will scale down text to fit.
@@ -162,7 +162,7 @@ fig.show()
162162

163163
### Controlling Maximum Text Size
164164

165-
The `textfont_size` parameter of the the [pie](/python/pie-charts), [bar](/python/bar-charts)-like, [sunburst](/python/sunburst-charts) and [treemap](/python/treemap-charts) traces can be used to set the **maximum font size** used in the chart. Note that the `textfont` parameter sets the `insidetextfont` and `outsidetextfont` parameter, which can also be set independently.
165+
The `textfont_size` parameter of the the [pie](/python/pie-charts), [bar](/python/bar-charts)-like, [sunburst](/python/sunburst-charts) and [treemap](/python/treemaps) traces can be used to set the **maximum font size** used in the chart. Note that the `textfont` parameter sets the `insidetextfont` and `outsidetextfont` parameter, which can also be set independently.
166166

167167
```python
168168
import plotly.express as px
@@ -353,7 +353,7 @@ fig.show()
353353

354354
*New in 5.22*
355355

356-
You can also configure a font's `variant`, `style`, and `weight` on `textfont`. Here, we configure an `italic` style on the first bar, `bold` weight on the second, and`small-caps` as the font variant on the third.
356+
You can also configure a font's `variant`, `style`, and `weight` on `textfont`. Here, we configure an `italic` style on the first bar, `bold` weight on the second, and `small-caps` as the font variant on the third.
357357

358358
```python
359359
import plotly.graph_objects as go

Diff for: doc/python/webgl-vs-svg.md

+2
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,12 @@ To use it, in the environment where your Plotly figures are being rendered, load
7272

7373
In a Jupyter notebook environment that supports magic commands, you can load it with the [HTML magic command](https://ipython.readthedocs.io/en/stable/interactive/magics.html#cellmagic-html):
7474

75+
<!-- #region -->
7576
```
7677
%%html
7778
<script src=“https://unpkg.com/[email protected]/src/virtual-webgl.js”></script>
7879
```
80+
<!-- #endregion -->
7981

8082
### WebGL for Scatter Performance
8183

0 commit comments

Comments
 (0)