Merge pull request #4683 from plotly/add-latest-docs-updates

Add latest docs updates to master
plotly · Jul 22, 2024 · bf78a8a · bf78a8a
2 parents 9b5ec6a + a32a981
commit bf78a8a
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 13 deletions.
diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile
@@ -36,7 +36,7 @@ help:
 	# Remove files which were added only for docstring generation
 	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
 	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
-	rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html
+	rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html _build/html/generated/generated/*.html
 	mv _build/html/generated/plotly.graph_objs.html _build/html/generated/plotly.graph_objects.html
 	sed -i 's/graph_objs/graph_objects/g' _build/html/*.html
 	sed -i 's/graph_objs/graph_objects/g' _build/html/*.inv

diff --git a/doc/python/configuration-options.md b/doc/python/configuration-options.md
@@ -252,7 +252,7 @@ fig.show()
 
 *New in v4.7*
 
-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.
+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.
 
 ```python
 import plotly.express as px

diff --git a/doc/python/multiple-axes.md b/doc/python/multiple-axes.md
@@ -357,7 +357,7 @@ fig.show()
 
 *New in 5.13*
 
-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. 
+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.
 
 ```python
 import plotly.graph_objects as go
@@ -415,4 +415,4 @@ fig.show()
 ```
 
 #### Reference
-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.
+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 --git a/doc/python/network-graphs.md b/doc/python/network-graphs.md
@@ -134,7 +134,7 @@ fig = go.Figure(data=[edge_trace, node_trace],
                 hovermode='closest',
                 margin=dict(b=20,l=5,r=5,t=40),
                 annotations=[ dict(
-                    text="Python code: <a href='https://plotly.com/ipython-notebooks/network-graphs/'> https://plotly.com/ipython-notebooks/network-graphs/</a>",
+                    text="Python code: <a href='https://plotly.com/python/network-graphs/'> https://plotly.com/python/network-graphs/</a>",
                     showarrow=False,
                     xref="paper", yref="paper",
                     x=0.005, y=-0.002 ) ],

diff --git a/doc/python/peak-finding.md b/doc/python/peak-finding.md
@@ -36,7 +36,7 @@ jupyter:
 
 #### Imports
 
-The tutorial below imports [Pandas](https://plotly.com/pandas/intro-to-pandas-tutorial/), and [SciPy](https://www.scipy.org/).
+The tutorial below imports [Pandas](https://pandas.pydata.org/docs/user_guide/10min.html), and [SciPy](https://www.scipy.org/).
 
 ```python
 import pandas as pd

diff --git a/doc/python/smoothing.md b/doc/python/smoothing.md
@@ -36,7 +36,7 @@ jupyter:
 
 #### Imports
 
-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/).
+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/).
 
 ```python
 import plotly.graph_objects as go

diff --git a/doc/python/static-image-export.md b/doc/python/static-image-export.md
@@ -101,7 +101,7 @@ if not os.path.exists("images"):
     os.mkdir("images")
 ```
 
-If you are running this notebook live, click to [open the output directory](./images) so you can examine the images as they are written.
+If you are running this notebook live, click to open the output directory so you can examine the images as they are written.
 
 
 #### Raster Formats: PNG, JPEG, and WebP

diff --git a/doc/python/subplots.md b/doc/python/subplots.md
@@ -619,8 +619,8 @@ fig = make_subplots(2, 3, horizontal_spacing=0.1)
 ```
 
 #### Reference
-All of the x-axis properties are found here: https://plotly.com/python/reference/XAxis/
-All of the y-axis properties are found here: https://plotly.com/python/reference/YAxis/
+All of the x-axis properties are found here: https://plotly.com/python/reference/layout/xaxis/
+All of the y-axis properties are found here: https://plotly.com/python/reference/layout/yaxis/
 
 ```python
 from plotly.subplots import make_subplots

diff --git a/doc/python/text-and-annotations.md b/doc/python/text-and-annotations.md
@@ -122,7 +122,7 @@ IFrame(snippet_url + 'text-and-annotations', width='100%', height=1200)
 
 ### Controlling Text Size with `uniformtext`
 
-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.
+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.
 
 
 Here is a bar chart with the default behavior which will scale down text to fit.
@@ -162,7 +162,7 @@ fig.show()
 
 ### Controlling Maximum Text Size
 
-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.
+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.
 
 ```python
 import plotly.express as px
@@ -353,7 +353,7 @@ fig.show()
 
 *New in 5.22*
 
-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.
+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.
 
 ```python
 import plotly.graph_objects as go

diff --git a/doc/python/webgl-vs-svg.md b/doc/python/webgl-vs-svg.md
@@ -72,10 +72,12 @@ To use it, in the environment where your Plotly figures are being rendered, load
 
 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):
 
+<!-- #region -->
 ```
 %%html
 <script src=“https://unpkg.com/[email protected]/src/virtual-webgl.js”></script>
 ```
+<!-- #endregion -->
 
 ### WebGL for Scatter Performance