Merge pull request plotly#4360 from plotly/update-doc-prod-with-5-17

Update docs to version 5.17

Author: LiamConnors

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 
 orbs:
-  browser-tools: circleci/[email protected].3
+  browser-tools: circleci/[email protected].5
 
 commands:
   test_core:

CHANGELOG.md

@@ -2,6 +2,20 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [5.17.0] - 2023-09-15
+
+### Updated
+- Improved json docstrings, added `BasePlotlyType.to_json()` method [[#4301](https://github.com/plotly/plotly.py/pull/4301)]
+- Updated Plotly.js from version 2.25.2 to version 2.26.0. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#2260----2023-08-24) for more information. These changes are reflected in the auto-generated `plotly.graph_objects` module. Notable changes include:
+   - Add "min", "max", "min reversed" and "max reversed" autorange options and handle partial ranges (i.e. one end being null), add `autorangeoptions` (`clipmin`, `clipmax`, `minallowed`, `maxallowed`, `include`) as well as `minallowed` and `maxallowed` to cartesian, gl3d and radial axes [[#6547](https://github.com/plotly/plotly.js/pull/6547)]
+   - Add [n]-sigma (std deviations) box plots as an alternative to quartiles [[#6697](https://github.com/plotly/plotly.js/issues/6697)], with thanks to @28raining for the contribution!
+   - Add "top left" & "top center" side options to legend title [[#6711](https://github.com/plotly/plotly.js/pull/6711)], with thanks to @28raining for the contribution!
+   - Add "false" option to `scaleanchor` to allow removing a constraint that is set by default [[#6712](https://github.com/plotly/plotly.js/pull/6712)], with thanks to @lvlte for the contribution!
+
+
+### Fixed
+- Fixed two issues with px.imshow: [[#4330](https://github.com/plotly/plotly.py/issues/4330)] when facet_col is an earlier dimension than animation_frame for xarrays and [[#4329](https://github.com/plotly/plotly.py/issues/4329)] when facet_col has string coordinates in xarrays [[#4331](https://github.com/plotly/plotly.py/pull/4331)]
+
 ## [5.16.1] - 2023-08-16
 
 ### Fixed

README.md

@@ -33,7 +33,7 @@
 
 ## Quickstart
 
-`pip install plotly==5.16.1`
+`pip install plotly==5.17.0`
 
 Inside [Jupyter](https://jupyter.org/install) (installable with `pip install "jupyterlab>=3" "ipywidgets>=7.6"`):
 
@@ -78,13 +78,13 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
 plotly.py may be installed using pip...
 
 ```
-pip install plotly==5.16.1
+pip install plotly==5.17.0
 ```
 
 or conda.
 
 ```
-conda install -c plotly plotly=5.16.1
+conda install -c plotly plotly=5.17.0
 ```
 
 ### JupyterLab Support
@@ -106,7 +106,7 @@ The instructions above apply to JupyterLab 3.x. **For JupyterLab 2 or earlier**,
 
 ```
 # JupyterLab 2.x renderer support
-jupyter labextension install jupyterlab-plotly@5.16.1 @jupyter-widgets/jupyterlab-manager
+jupyter labextension install jupyterlab-plotly@5.17.0 @jupyter-widgets/jupyterlab-manager
 ```
 
 Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.

binder/requirements.txt

@@ -1,5 +1,5 @@
 jupytext
-plotly==5.16.1
+plotly==5.17.0
 jupyter
 notebook
 pandas==1.0.3

doc/apidoc/conf.py

@@ -28,7 +28,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "5.16.1"
+release = "5.17.0"
 
 
 # -- General configuration ---------------------------------------------------

doc/python/3d-axes.md

@@ -5,10 +5,10 @@ jupyter:
     text_representation:
       extension: .md
       format_name: markdown
-      format_version: '1.1'
-      jupytext_version: 1.1.1
+      format_version: '1.3'
+      jupytext_version: 1.15.1
   kernelspec:
-    display_name: Python 3
+    display_name: Python 3 (ipykernel)
     language: python
     name: python3
   language_info:
@@ -20,7 +20,7 @@ jupyter:
     name: python
     nbconvert_exporter: python
     pygments_lexer: ipython3
-    version: 3.7.3
+    version: 3.10.4
   plotly:
     description: How to format axes of 3d plots in Python with Plotly.
     display_as: 3d_charts
@@ -41,6 +41,8 @@ set the range, title, ticks, color etc. of the axes.
 
 For creating 3D charts, see [this page](https://plotly.com/python/3d-charts/).
 
+Set `range` on an axis to manually configure a range for that axis. If you don't set `range`, it's automatically calculated. In this example, we set a `range` on `xaxis`, `yaxis`, and `zaxis`.
+
 ```python
 import plotly.graph_objects as go
 import numpy as np
@@ -66,6 +68,37 @@ fig.update_layout(
 fig.show()
 ```
 
+### Setting only a Lower or Upper Bound for Range
+
+*New in 5.17*
+
+You can also set just a lower or upper bound for `range`. In this case, autorange is used for the other bound. In this example, we apply autorange to the lower bound of the `yaxis` and the upper bound of `zaxis` by setting them to `None`.
+
+```python
+import plotly.graph_objects as go
+import numpy as np
+np.random.seed(1)
+
+N = 70
+
+fig = go.Figure(data=[go.Mesh3d(x=(70*np.random.randn(N)),
+                   y=(55*np.random.randn(N)),
+                   z=(40*np.random.randn(N)),
+                   opacity=0.5,
+                   color='rgba(244,22,100,0.6)'
+                  )])
+
+fig.update_layout(
+    scene = dict(
+        xaxis = dict(nticks=4, range=[-100,100],),
+                     yaxis = dict(nticks=4, range=[None, 100],),
+                     zaxis = dict(nticks=4, range=[-100, None],),),
+    width=700,
+    margin=dict(r=20, l=10, b=10, t=10))
+
+fig.show()
+```
+
 ### Fixed Ratio Axes
 
 ```python
@@ -226,7 +259,3 @@ fig.update_layout(scene=dict(xaxis_showspikes=False,
                              yaxis_showspikes=False))
 fig.show()
 ```
-
-```python
-
-```