From 5365e55ba229e857662c4082d5bc9d91e407b193 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 10:37:04 +0200 Subject: [PATCH 01/19] add sphinx apidoc to circleci artifacts --- .circleci/config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 854036d4667..d2a1ec43efb 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -484,6 +484,9 @@ jobs: - store_artifacts: path: doc/build destination: doc/build + - store_artifacts: + path: doc/apidoc/_build/html + destination: doc/apidoc/_build/html workflows: version: 2 From 06a3d97638704b210b59daa66865337dcf1bde4e Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 11:20:21 +0200 Subject: [PATCH 02/19] added bison to try to fix ci --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index d2a1ec43efb..3029c94faec 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -409,7 +409,7 @@ jobs: cd ../../../doc fi echo 'export PATH="/home/circleci/project/doc/node_modules/.bin:$PATH"' >> $BASH_ENV - sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename + sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename bison cd .. - save_cache: From 5e72089ea86934b36ae9006405e3bd1865e68718 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 11:30:26 +0200 Subject: [PATCH 03/19] debug --- .circleci/config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 3029c94faec..e62fbeb6788 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -400,6 +400,7 @@ jobs: . venv/bin/activate npm install electron@1.8.4 npm install orca + sudo apt install -y bison pip uninstall -y plotly pip install -r requirements.txt if [ "${CIRCLE_BRANCH}" != "doc-prod" ]; then @@ -409,7 +410,7 @@ jobs: cd ../../../doc fi echo 'export PATH="/home/circleci/project/doc/node_modules/.bin:$PATH"' >> $BASH_ENV - sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename bison + sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename cd .. - save_cache: From b2ac635aef41c1f53ed01e31c1fc3201febf1f5d Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 11:42:01 +0200 Subject: [PATCH 04/19] debug --- .circleci/config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index e62fbeb6788..6d8019fd231 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -400,7 +400,8 @@ jobs: . venv/bin/activate npm install electron@1.8.4 npm install orca - sudo apt install -y bison + sudo apt install -y bison flex + pip install -U pip pip uninstall -y plotly pip install -r requirements.txt if [ "${CIRCLE_BRANCH}" != "doc-prod" ]; then From 902c92a79bdd3a9af5bb1a13c1e90268329e9d11 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 11:55:45 +0200 Subject: [PATCH 05/19] debug --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 6d8019fd231..9098a199fe7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -400,7 +400,7 @@ jobs: . venv/bin/activate npm install electron@1.8.4 npm install orca - sudo apt install -y bison flex + # sudo apt install -y bison flex pip install -U pip pip uninstall -y plotly pip install -r requirements.txt From 2f8986adb861e6008713a56778b12d84f3742c0b Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 12:00:45 +0200 Subject: [PATCH 06/19] debug --- .circleci/config.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 9098a199fe7..9518a4e0791 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -400,7 +400,6 @@ jobs: . venv/bin/activate npm install electron@1.8.4 npm install orca - # sudo apt install -y bison flex pip install -U pip pip uninstall -y plotly pip install -r requirements.txt From bb72ff8a9c709991cb4db5eabd57f1b7d1b3cefe Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 15:45:53 +0200 Subject: [PATCH 07/19] simplify Makefile --- doc/apidoc/Makefile | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index 2581f378c14..11435bdd7aa 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = python -m sphinx +SPHINXBUILD = python3 -m sphinx SOURCEDIR = . BUILDDIR = _build @@ -18,21 +18,15 @@ help: # For sphinx-apidoc the first positional path is the module to document # then all the other ones are paths to exclude for the doc generation %: Makefile - sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*.py - sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*.py - sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*.py - sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*/*.py + # Copy _plotly_utils file so that they appear in the API doc cp ../../packages/python/plotly/_plotly_utils/colors/sequential.py ../../packages/python/plotly/_plotly_utils/colors/diverging.py ../../packages/python/plotly/_plotly_utils/colors/qualitative.py ../../packages/python/plotly/_plotly_utils/colors/cyclical.py ../../packages/python/plotly/_plotly_utils/colors/colorbrewer.py ../../packages/python/plotly/_plotly_utils/colors/carto.py ../../packages/python/plotly/_plotly_utils/colors/cmocean.py ../../packages/python/plotly/plotly/colors cp ../../packages/python/plotly/_plotly_utils/colors/sequential.py ../../packages/python/plotly/_plotly_utils/colors/diverging.py ../../packages/python/plotly/_plotly_utils/colors/qualitative.py ../../packages/python/plotly/_plotly_utils/colors/cyclical.py ../../packages/python/plotly/_plotly_utils/colors/colorbrewer.py ../../packages/python/plotly/_plotly_utils/colors/carto.py ../../packages/python/plotly/_plotly_utils/colors/cmocean.py ../../packages/python/plotly/plotly/express/colors + # Run sphinx-apidoc script to create hierarchy of rst files to generate + # docstrings. The first path is the one to process, the following ones + # are excluded from the search. sphinx-apidoc -M -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api + # Run sphinx-build to build html pages from the rst pages @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - git checkout -- ../../packages/python/plotly/plotly/graph_objs + # 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 - 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 - sed -i 's/graph_objs/graph_objects/g' _build/html/*.js - sed -i 's/graph_objs/graph_objects/g' _build/html/generated/*.html - sed -i 's/graph_objs/graph_objects/g' _build/html/generated/generated/*.html From 7fafe81873b4f3f63194e36a5a0fb85b6ff87dad Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 16:21:50 +0200 Subject: [PATCH 08/19] debug --- doc/apidoc/Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index 11435bdd7aa..d2e09bcf4ce 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -24,6 +24,7 @@ help: # Run sphinx-apidoc script to create hierarchy of rst files to generate # docstrings. The first path is the one to process, the following ones # are excluded from the search. + rm -rf _build generated sphinx-apidoc -M -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api # Run sphinx-build to build html pages from the rst pages @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) From 740d4f8494b23f682a9860d942305a84f69c3923 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 16:52:22 +0200 Subject: [PATCH 09/19] try to build the doc on python 3.7 (lazy import) --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 9518a4e0791..25084caeb94 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -374,7 +374,7 @@ jobs: docker: # specify the version you desire here # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers` - - image: circleci/python:3.6.8-node + - image: circleci/python:3.7-stretch-node-browsers working_directory: ~/project From 75522ec0a6a07d5d744c16d5856190a00b950178 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 17:03:11 +0200 Subject: [PATCH 10/19] empty space commit --- doc/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 9aebfc9ce64..51c56a393a1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -23,5 +23,5 @@ recommonmark pathlib python-frontmatter datashader -pyarrow +pyarrow cufflinks==0.17.3 From 5543c26eb69597eb5f40ab83ed17b13837dd72fe Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 17:29:23 +0200 Subject: [PATCH 11/19] sed --- doc/apidoc/Makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index d2e09bcf4ce..4b77f4b1559 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -18,6 +18,10 @@ help: # For sphinx-apidoc the first positional path is the module to document # then all the other ones are paths to exclude for the doc generation %: Makefile + sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*.py + sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*.py + sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*.py + sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*/*.py # Copy _plotly_utils file so that they appear in the API doc cp ../../packages/python/plotly/_plotly_utils/colors/sequential.py ../../packages/python/plotly/_plotly_utils/colors/diverging.py ../../packages/python/plotly/_plotly_utils/colors/qualitative.py ../../packages/python/plotly/_plotly_utils/colors/cyclical.py ../../packages/python/plotly/_plotly_utils/colors/colorbrewer.py ../../packages/python/plotly/_plotly_utils/colors/carto.py ../../packages/python/plotly/_plotly_utils/colors/cmocean.py ../../packages/python/plotly/plotly/colors cp ../../packages/python/plotly/_plotly_utils/colors/sequential.py ../../packages/python/plotly/_plotly_utils/colors/diverging.py ../../packages/python/plotly/_plotly_utils/colors/qualitative.py ../../packages/python/plotly/_plotly_utils/colors/cyclical.py ../../packages/python/plotly/_plotly_utils/colors/colorbrewer.py ../../packages/python/plotly/_plotly_utils/colors/carto.py ../../packages/python/plotly/_plotly_utils/colors/cmocean.py ../../packages/python/plotly/plotly/express/colors From eddae2a82181d5aa18482d497b7590a6bd9a698f Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 17:51:04 +0200 Subject: [PATCH 12/19] clean working tree when building doc --- doc/apidoc/Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index 4b77f4b1559..1359e9205fb 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -32,6 +32,7 @@ help: sphinx-apidoc -M -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api # Run sphinx-build to build html pages from the rst pages @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + git checkout -- ../../packages/python/plotly/plotly/graph_objs # 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 From d5700cc823e5f8b814b317f4c265d303191d0d05 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 18:11:50 +0200 Subject: [PATCH 13/19] sed back --- doc/apidoc/Makefile | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index 1359e9205fb..a0580f27135 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -36,3 +36,10 @@ 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 + 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 + sed -i 's/graph_objs/graph_objects/g' _build/html/*.js + sed -i 's/graph_objs/graph_objects/g' _build/html/generated/*.html + sed -i 's/graph_objs/graph_objects/g' _build/html/generated/generated/*.html From c2796eeeed630ec7a144b5698dbe68d113885322 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 18:40:01 +0200 Subject: [PATCH 14/19] zip apidoc to download it, print sphinx-build version --- .circleci/config.yml | 6 +++--- doc/apidoc/Makefile | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 25084caeb94..08487c83bff 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -479,15 +479,15 @@ jobs: rm -rf .git cd ../.. fi - + tar -zcf _build/api.tgz _build/html cd ../.. - store_artifacts: path: doc/build destination: doc/build - store_artifacts: - path: doc/apidoc/_build/html - destination: doc/apidoc/_build/html + path: doc/apidoc/_build/ + destination: doc/apidoc/_build/ workflows: version: 2 diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index a0580f27135..f7591037193 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -18,6 +18,7 @@ help: # For sphinx-apidoc the first positional path is the module to document # then all the other ones are paths to exclude for the doc generation %: Makefile + sphinx-build --version sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*.py sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*.py sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*.py From 33da55ba9721bbe865810c3a9b10f0eba9c68324 Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Mon, 3 Aug 2020 17:08:17 -0400 Subject: [PATCH 15/19] fix internal reference links --- doc/python/2D-Histogram.md | 4 ++-- doc/python/2d-histogram-contour.md | 2 +- doc/python/3d-bubble-charts.md | 6 +++--- doc/python/3d-camera-controls.md | 2 +- doc/python/3d-isosurface-plots.md | 2 +- doc/python/3d-line-plots.md | 2 +- doc/python/3d-mesh.md | 2 +- doc/python/3d-scatter-plots.md | 2 +- doc/python/3d-surface-plots.md | 6 +++--- doc/python/3d-volume.md | 2 +- doc/python/animations.md | 2 +- doc/python/annotated-heatmap.md | 2 +- doc/python/axes.md | 16 ++++++++-------- doc/python/bar-charts.md | 4 ++-- doc/python/box-plots.md | 4 ++-- doc/python/bubble-charts.md | 6 +++--- doc/python/bubble-maps.md | 4 ++-- doc/python/bullet-charts.md | 4 ++-- doc/python/candlestick-charts.md | 2 +- doc/python/carpet-contour.md | 4 ++-- doc/python/carpet-plot.md | 4 ++-- doc/python/carpet-scatter.md | 2 +- doc/python/choropleth-maps.md | 2 +- doc/python/colorscales.md | 8 ++++---- doc/python/compare-webgl-svg.md | 4 ++-- doc/python/contour-plots.md | 2 +- doc/python/custom-buttons.md | 4 ++-- doc/python/dot-plots.md | 2 +- doc/python/dropdowns.md | 4 ++-- doc/python/error-bars.md | 2 +- doc/python/figure-labels.md | 4 ++-- doc/python/filled-area-on-mapbox.md | 8 ++++---- doc/python/filled-area-plots.md | 4 ++-- doc/python/funnel-charts.md | 4 ++-- doc/python/gauge-charts.md | 4 ++-- doc/python/heatmaps.md | 4 ++-- doc/python/histograms.md | 6 +++--- doc/python/horizontal-bar-charts.md | 4 ++-- doc/python/hover-text-and-formatting.md | 6 +++--- doc/python/images.md | 2 +- doc/python/imshow.md | 2 +- doc/python/indicator.md | 2 +- doc/python/legend.md | 4 ++-- doc/python/line-and-scatter.md | 4 ++-- doc/python/line-charts.md | 6 +++--- doc/python/lines-on-mapbox.md | 6 +++--- doc/python/lines-on-maps.md | 2 +- doc/python/log-plot.md | 2 +- doc/python/map-configuration.md | 2 +- doc/python/map-subplots-and-small-multiples.md | 2 +- doc/python/mapbox-county-choropleth.md | 2 +- doc/python/mapbox-density-heatmaps.md | 2 +- doc/python/mapbox-layers.md | 2 +- doc/python/multiple-axes.md | 2 +- doc/python/network-graphs.md | 2 +- doc/python/ohlc-charts.md | 2 +- doc/python/parallel-categories-diagram.md | 2 +- doc/python/parallel-coordinates-plot.md | 2 +- doc/python/pie-charts.md | 2 +- doc/python/polar-chart.md | 4 ++-- doc/python/radar-chart.md | 2 +- doc/python/range-slider.md | 2 +- doc/python/sankey-diagram.md | 8 ++++---- doc/python/scatter-plots-on-maps.md | 2 +- doc/python/scattermapbox.md | 4 ++-- doc/python/setting-graph-size.md | 4 ++-- doc/python/shapes.md | 4 ++-- doc/python/sliders.md | 4 ++-- doc/python/splom.md | 2 +- doc/python/streamtube-plot.md | 2 +- doc/python/subplots.md | 6 +++--- doc/python/sunburst-charts.md | 4 ++-- doc/python/table-subplots.md | 2 +- doc/python/table.md | 2 +- doc/python/ternary-plots.md | 2 +- doc/python/text-and-annotations.md | 12 ++++++------ doc/python/tick-formatting.md | 2 +- doc/python/time-series.md | 8 ++++---- doc/python/treemaps.md | 16 ++++++++-------- doc/python/violin.md | 4 ++-- doc/python/waterfall-charts.md | 6 +++--- doc/python/webgl-vs-svg.md | 2 +- doc/python/wind-rose-charts.md | 2 +- 83 files changed, 157 insertions(+), 157 deletions(-) diff --git a/doc/python/2D-Histogram.md b/doc/python/2D-Histogram.md index 0b283e22e07..140bfa08a00 100644 --- a/doc/python/2D-Histogram.md +++ b/doc/python/2D-Histogram.md @@ -137,7 +137,7 @@ fig = go.Figure(go.Histogram2d(x=x, y=y, histnorm='probability', fig.show() ``` ### Sharing bin settings between 2D Histograms -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`. +This example shows how to use [bingroup](https://plotly.com/python/reference/histogram/#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/#histogram2dcontour-ybins) and `xbins`. ```python import plotly.graph_objects as go @@ -236,4 +236,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#histogram2d for more information and chart attribute options! +See https://plotly.com/python/reference/histogram2d/ for more information and chart attribute options! diff --git a/doc/python/2d-histogram-contour.md b/doc/python/2d-histogram-contour.md index 08fb3cce5dd..f9c107d568c 100644 --- a/doc/python/2d-histogram-contour.md +++ b/doc/python/2d-histogram-contour.md @@ -249,4 +249,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#histogram2dcontour for more information and chart attribute options! +See https://plotly.com/python/reference/histogram2dcontour/ for more information and chart attribute options! diff --git a/doc/python/3d-bubble-charts.md b/doc/python/3d-bubble-charts.md index 4f5f013ab50..0877a6b55e4 100644 --- a/doc/python/3d-bubble-charts.md +++ b/doc/python/3d-bubble-charts.md @@ -107,7 +107,7 @@ fig = go.Figure(data=go.Scatter3d( mode = 'markers', marker = dict( sizemode = 'diameter', - sizeref = 750, # info on sizeref: https://plotly.com/python/reference/#scatter-marker-sizeref + sizeref = 750, # info on sizeref: https://plotly.com/python/reference/scatter/#scatter-marker-sizeref size = planet_diameter, color = planet_colors, ) @@ -146,7 +146,7 @@ fig = go.Figure(go.Scatter3d( mode = 'markers', marker = dict( sizemode = 'diameter', - sizeref = 750, # info on sizeref: https://plotly.com/python/reference/#scatter-marker-sizeref + sizeref = 750, # info on sizeref: https://plotly.com/python/reference/scatter/#scatter-marker-sizeref size = planet_diameter, color = temperatures, colorbar_title = 'Mean
Temperature', @@ -166,4 +166,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter3d and https://plotly.com/python/reference/#scatter-marker-sizeref
for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter3d/ and https://plotly.com/python/reference/scatter/#scatter-marker-sizeref
for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/3d-camera-controls.md b/doc/python/3d-camera-controls.md index 0e2457bc45e..5ec5879bb26 100644 --- a/doc/python/3d-camera-controls.md +++ b/doc/python/3d-camera-controls.md @@ -290,4 +290,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#layout-scene-camera for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/layout/scene/#layout-scene-camera for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/3d-isosurface-plots.md b/doc/python/3d-isosurface-plots.md index a08deebf694..b94a27c509a 100644 --- a/doc/python/3d-isosurface-plots.md +++ b/doc/python/3d-isosurface-plots.md @@ -235,4 +235,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#isosurface for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/isosurface/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/3d-line-plots.md b/doc/python/3d-line-plots.md index 77831521539..172422bc9c0 100644 --- a/doc/python/3d-line-plots.md +++ b/doc/python/3d-line-plots.md @@ -120,4 +120,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter3d-marker-line for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter3d/#scatter3d-marker-line for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/3d-mesh.md b/doc/python/3d-mesh.md index ce91bc56f7c..ca149187dde 100644 --- a/doc/python/3d-mesh.md +++ b/doc/python/3d-mesh.md @@ -163,4 +163,4 @@ fig.show() ``` ## Reference -See https://plotly.com/python/reference/#mesh3d for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/mesh3d/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/3d-scatter-plots.md b/doc/python/3d-scatter-plots.md index 9ccdfae4f9d..8705d9b7f31 100644 --- a/doc/python/3d-scatter-plots.md +++ b/doc/python/3d-scatter-plots.md @@ -122,4 +122,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter3d for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter3d/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/3d-surface-plots.md b/doc/python/3d-surface-plots.md index 010f6649512..fbace329f60 100644 --- a/doc/python/3d-surface-plots.md +++ b/doc/python/3d-surface-plots.md @@ -77,7 +77,7 @@ fig.show() #### Surface Plot With Contours -Display and customize contour data for each axis using the `contours` attribute ([reference](plotly.com/python/reference/#surface-contours)). +Display and customize contour data for each axis using the `contours` attribute ([reference](plotly.com/python/reference/surface/#surface-contours)). ```python import plotly.graph_objects as go @@ -99,7 +99,7 @@ fig.update_layout(title='Mt Bruno Elevation', autosize=False, fig.show() ``` #### Configure Surface Contour Levels -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. +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/#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. ```python import plotly.graph_objects as go @@ -196,4 +196,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#surface for more information! +See https://plotly.com/python/reference/surface/ for more information! diff --git a/doc/python/3d-volume.md b/doc/python/3d-volume.md index 1c22ffb9799..5dde49cf63c 100644 --- a/doc/python/3d-volume.md +++ b/doc/python/3d-volume.md @@ -254,7 +254,7 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#volume for more information and chart attribute options! +See https://plotly.com/python/reference/volume/ for more information and chart attribute options! #### See also [3D isosurface documentation](/python/3d-isosurface-plots/) \ No newline at end of file diff --git a/doc/python/animations.md b/doc/python/animations.md index c819fb68c8e..4fc9b08e300 100644 --- a/doc/python/animations.md +++ b/doc/python/animations.md @@ -69,7 +69,7 @@ Along with `data` and `layout`, `frames` can be added as a key in a figure objec #### Adding Control Buttons to Animations -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). +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/).
The buttons are defined as follows: diff --git a/doc/python/annotated-heatmap.md b/doc/python/annotated-heatmap.md index 257fc85c09b..ddd62e66cbb 100644 --- a/doc/python/annotated-heatmap.md +++ b/doc/python/annotated-heatmap.md @@ -203,4 +203,4 @@ fig.show() #### Reference -For more info on Plotly heatmaps, see: https://plotly.com/python/reference/#heatmap.
For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/
For more info on `ff.create_annotated_heatmap()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_annotated_heatmap.html#plotly.figure_factory.create_annotated_heatmap) \ No newline at end of file +For more info on Plotly heatmaps, see: https://plotly.com/python/reference/heatmap/.
For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/
For more info on `ff.create_annotated_heatmap()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_annotated_heatmap.html#plotly.figure_factory.create_annotated_heatmap) \ No newline at end of file diff --git a/doc/python/axes.md b/doc/python/axes.md index 38410f143fa..182773c7a96 100644 --- a/doc/python/axes.md +++ b/doc/python/axes.md @@ -34,14 +34,14 @@ jupyter: thumbnail: thumbnail/axes.png --- -This tutorial explain how to set the properties of 2-dimensional Cartesian axes, namely [`go.layout.XAxis`](/python/reference/#layout-xaxis) and [`go.layout.YAxis`](python/reference/#layout-xaxis). Other kinds of axes are described in other tutorials: +This tutorial explain how to set the properties of 2-dimensional Cartesian axes, namely [`go.layout.XAxis`](/python/reference/layout/xaxis/) and [`go.layout.YAxis`](python/reference/layout/xaxis/). Other kinds of axes are described in other tutorials: -- [3D axes](/python/3d-axes) The axis object is [`go.layout.Scene`](/python/reference/#layout-scene) -- [Polar axes](/python/polar-chart/). The axis object is [`go.layout.Polar`](/python/reference/#layout-polar) -- [Ternary axes](/python/ternary-plots). The axis object is [`go.layout.Ternary`](/python/reference/#layout-ternary) -- [Geo axes](/python/map-configuration/). The axis object is [`go.layout.Geo`](/python/reference/#layout-geo) -- [Mapbox axes](/python/mapbox-layers/). The axis object is [`go.layout.Mapbox`](/python/reference/#layout-mapbox) -- [Color axes](/python/colorscales/). The axis object is [`go.layout.Coloraxis`](/python/reference/#layout-coloraxis). +- [3D axes](/python/3d-axes) The axis object is [`go.layout.Scene`](/python/reference/layout/scene/) +- [Polar axes](/python/polar-chart/). The axis object is [`go.layout.Polar`](/python/reference/layout/polar/) +- [Ternary axes](/python/ternary-plots). The axis object is [`go.layout.Ternary`](/python/reference/layout/ternary/) +- [Geo axes](/python/map-configuration/). The axis object is [`go.layout.Geo`](/python/reference/layout/geo/) +- [Mapbox axes](/python/mapbox-layers/). The axis object is [`go.layout.Mapbox`](/python/reference/layout/mapbox/) +- [Color axes](/python/colorscales/). The axis object is [`go.layout.Coloraxis`](/python/reference/layout/coloraxis/). **See also** the tutorials on [subplots](/python/subplots) and [multiple axes](/python/multiple-axes/). @@ -777,4 +777,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#layout-xaxis and https://plotly.com/python/reference/#layout-yaxis for more information and chart attribute options! +See https://plotly.com/python/reference/layout/xaxis/ and https://plotly.com/python/reference/layout/yaxis/ for more information and chart attribute options! diff --git a/doc/python/bar-charts.md b/doc/python/bar-charts.md index 11a2ca910c0..a03237ce155 100644 --- a/doc/python/bar-charts.md +++ b/doc/python/bar-charts.md @@ -372,7 +372,7 @@ fig.show() ### Bar Chart with Sorted or Ordered Categories -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. +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/#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. This example orders the bar chart alphabetically with `categoryorder: 'category ascending'` @@ -442,4 +442,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#bar for more information and chart attribute options! +See https://plotly.com/python/reference/bar/ for more information and chart attribute options! diff --git a/doc/python/box-plots.md b/doc/python/box-plots.md index 912f52f292f..659863faed5 100644 --- a/doc/python/box-plots.md +++ b/doc/python/box-plots.md @@ -134,7 +134,7 @@ fig.show() ## Box plot with go.Box -If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Box` class from `plotly.graph_objects`](/python/graph-objects/). All available options for `go.Box` are described in the reference page https://plotly.com/python/reference/#box. +If Plotly Express does not provide a good starting point, it is also possible to use [the more generic `go.Box` class from `plotly.graph_objects`](/python/graph-objects/). All available options for `go.Box` are described in the reference page https://plotly.com/python/reference/box/. ### Basic Box Plot @@ -502,4 +502,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#box for more information and chart attribute options! +See https://plotly.com/python/reference/box/ for more information and chart attribute options! diff --git a/doc/python/bubble-charts.md b/doc/python/bubble-charts.md index dbb2d958dfb..411b6f0b990 100644 --- a/doc/python/bubble-charts.md +++ b/doc/python/bubble-charts.md @@ -91,8 +91,8 @@ fig.show() To scale the bubble size, use the attribute `sizeref`. We recommend using the following formula to calculate a `sizeref` value:
`sizeref = 2. * max(array of size values) / (desired maximum marker size ** 2)`
-Note that setting 'sizeref' to a value greater than 1, decreases the rendered marker sizes, while setting 'sizeref' to less than 1, increases the rendered marker sizes. See https://plotly.com/python/reference/#scatter-marker-sizeref for more information. -Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/#scatter-marker-sizemode to area. +Note that setting 'sizeref' to a value greater than 1, decreases the rendered marker sizes, while setting 'sizeref' to less than 1, increases the rendered marker sizes. See https://plotly.com/python/reference/scatter/#scatter-marker-sizeref for more information. +Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/scatter/#scatter-marker-sizemode to area. ```python import plotly.graph_objects as go @@ -222,4 +222,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#scatter for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/bubble-maps.md b/doc/python/bubble-maps.md index d2fbd9c2a77..7ba433a3331 100644 --- a/doc/python/bubble-maps.md +++ b/doc/python/bubble-maps.md @@ -74,7 +74,7 @@ To scale the bubble size, use the attribute sizeref. We recommend using the foll Note that setting `sizeref` to a value greater than $1$, decreases the rendered marker sizes, while setting `sizeref` to less than $1$, increases the rendered marker sizes. -See https://plotly.com/python/reference/#scatter-marker-sizeref for more information. Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/#scatter-marker-sizemode to area. +See https://plotly.com/python/reference/scatter/#scatter-marker-sizeref for more information. Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/scatter/#scatter-marker-sizemode to area. ```python import plotly.graph_objects as go @@ -208,4 +208,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#choropleth and https://plotly.com/python/reference/#scattergeo for more information and chart attribute options! +See https://plotly.com/python/reference/choropleth/ and https://plotly.com/python/reference/scattergeo/ for more information and chart attribute options! diff --git a/doc/python/bullet-charts.md b/doc/python/bullet-charts.md index 5fe757f4c68..c639b924154 100644 --- a/doc/python/bullet-charts.md +++ b/doc/python/bullet-charts.md @@ -78,7 +78,7 @@ fig.show() ``` #### Custom Bullet -The following example shows how to customize your charts. For more information about all possible options check our [reference page](https://plotly.com/python/reference/#indicator). +The following example shows how to customize your charts. For more information about all possible options check our [reference page](https://plotly.com/python/reference/indicator/). ```python import plotly.graph_objects as go @@ -167,7 +167,7 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#indicator for more information and chart attribute options! +See https://plotly.com/python/reference/indicator/ for more information and chart attribute options! ```python diff --git a/doc/python/candlestick-charts.md b/doc/python/candlestick-charts.md index d5e3a6b91d5..a343c32742a 100644 --- a/doc/python/candlestick-charts.md +++ b/doc/python/candlestick-charts.md @@ -144,4 +144,4 @@ fig.show() ``` #### Reference -For more information on candlestick attributes, see: https://plotly.com/python/reference/#candlestick \ No newline at end of file +For more information on candlestick attributes, see: https://plotly.com/python/reference/candlestick/ \ No newline at end of file diff --git a/doc/python/carpet-contour.md b/doc/python/carpet-contour.md index fedd6fe3c51..8dad7c177c3 100644 --- a/doc/python/carpet-contour.md +++ b/doc/python/carpet-contour.md @@ -37,7 +37,7 @@ jupyter: ### Basic Carpet Plot -Set the `x` and `y` coorindates, using `x` and `y` attributes. If `x` coorindate values are ommitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/#carpet-aaxis). +Set the `x` and `y` coorindates, using `x` and `y` attributes. If `x` coorindate values are ommitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/carpet/#carpet-aaxis). ```python import plotly.graph_objects as go @@ -286,4 +286,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#contourcarpet for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/contourcarpet/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/carpet-plot.md b/doc/python/carpet-plot.md index ffe778fd713..5fcb7c75fb6 100644 --- a/doc/python/carpet-plot.md +++ b/doc/python/carpet-plot.md @@ -70,7 +70,7 @@ fig.show() ### Add A and B axis -Use `aaxis` or `baxis` list to make changes to the axes. For a more detailed list of attributes refer to [R reference](https://plotly.com/r/reference/#carpet-aaxis). +Use `aaxis` or `baxis` list to make changes to the axes. For a more detailed list of attributes refer to [R reference](https://plotly.com/r/reference/carpet/#carpet-aaxis). ```python inputHidden=false outputHidden=false import plotly.graph_objects as go @@ -189,4 +189,4 @@ To add points and lines see [Carpet Scatter Plots](https://plotly.com/python/car ### Reference -See https://plotly.com/python/reference/#carpet for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/carpet/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/carpet-scatter.md b/doc/python/carpet-scatter.md index 052a081d29b..e482288acd6 100644 --- a/doc/python/carpet-scatter.md +++ b/doc/python/carpet-scatter.md @@ -186,4 +186,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#scattercarpet for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scattercarpet/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/choropleth-maps.md b/doc/python/choropleth-maps.md index 7650fc93a34..c8414f53763 100644 --- a/doc/python/choropleth-maps.md +++ b/doc/python/choropleth-maps.md @@ -347,4 +347,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#choropleth for more information and chart attribute options! +See https://plotly.com/python/reference/choropleth/ for more information and chart attribute options! diff --git a/doc/python/colorscales.md b/doc/python/colorscales.md index ca568a94291..6616e0cf084 100644 --- a/doc/python/colorscales.md +++ b/doc/python/colorscales.md @@ -209,7 +209,7 @@ fig.show() ### Hiding or Customizing the Plotly Express Color Bar -Plotly Express binds all traces to [`layout.coloraxis`](/python/reference/#layout-coloraxis), rather than using trace-specific color axes. This means that the color bar can configured there, for example it can be hidden: +Plotly Express binds all traces to [`layout.coloraxis`](/python/reference/layout/coloraxis/), rather than using trace-specific color axes. This means that the color bar can configured there, for example it can be hidden: ```python import plotly.express as px @@ -417,7 +417,7 @@ fig.show() ### Setting the Midpoint of a Diverging Color scale with Graph Objects -The following example uses the [marker.cmid](https://plotly.com/python/reference/#scatter-marker-cmid) attribute to set the mid-point of the color domain by scaling 'cmin' and/or 'cmax' to be equidistant to this point. It only has impact when [marker.color](https://plotly.com/python/reference/#scattercarpet-marker-line-color) sets to a numerical array, and 'marker.cauto' is `True`. +The following example uses the [marker.cmid](https://plotly.com/python/reference/scatter/#scatter-marker-cmid) attribute to set the mid-point of the color domain by scaling 'cmin' and/or 'cmax' to be equidistant to this point. It only has impact when [marker.color](https://plotly.com/python/reference/scattercarpet/#scattercarpet-marker-line-color) sets to a numerical array, and 'marker.cauto' is `True`. ```python import plotly.graph_objects as go @@ -431,7 +431,7 @@ fig.add_trace(go.Scatter( fig.show() ``` -The heatmap chart uses [marker.zmid](https://plotly.com/python/reference/#scatter-marker-zmid) attribute to set the mid-point of the color domain. +The heatmap chart uses [marker.zmid](https://plotly.com/python/reference/scatter/#scatter-marker-zmid) attribute to set the mid-point of the color domain. ```python import plotly.graph_objects as go @@ -507,7 +507,7 @@ fig.show() ### Sharing a Color Axis with Graph Objects -To share colorscale information in multiple subplots, you can use [coloraxis](https://plotly.com/javascript/reference/#scatter-marker-line-coloraxis). +To share colorscale information in multiple subplots, you can use [coloraxis](https://plotly.com/javascript/reference/scatter/#scatter-marker-line-coloraxis). ```python import plotly.graph_objects as go diff --git a/doc/python/compare-webgl-svg.md b/doc/python/compare-webgl-svg.md index 62c50ef2483..cf806b58327 100644 --- a/doc/python/compare-webgl-svg.md +++ b/doc/python/compare-webgl-svg.md @@ -101,5 +101,5 @@ fig.show() For more information see
-`Scattergl()` : https://plotly.com/python/reference/#scattergl
-`Scatter()` : https://plotly.com/python/reference/#scatter +`Scattergl()` : https://plotly.com/python/reference/scattergl/
+`Scatter()` : https://plotly.com/python/reference/scatter/ diff --git a/doc/python/contour-plots.md b/doc/python/contour-plots.md index 3d6a41fa7dd..feb4f3b68a2 100644 --- a/doc/python/contour-plots.md +++ b/doc/python/contour-plots.md @@ -339,4 +339,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#contour for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/contour/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/custom-buttons.md b/doc/python/custom-buttons.md index 2b329b0f631..1c673126ee4 100644 --- a/doc/python/custom-buttons.md +++ b/doc/python/custom-buttons.md @@ -34,7 +34,7 @@ jupyter: --- #### Methods -The [updatemenu method](https://plot.ly/python/reference/#layout-updatemenus-items-updatemenu-buttons-items-button-method) determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods: +The [updatemenu method](https://plot.ly/python/reference/layout/updatemenus/#layout-updatemenus-items-updatemenu-buttons-items-button-method) determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods: - `"restyle"`: modify **data** or data attributes - `"relayout"`: modify **layout** attributes - `"update"`: modify **data and layout** attributes; combination of `"restyle"` and `"relayout"` @@ -460,4 +460,4 @@ Refer to our animation docs: https://plotly.com/python/#animations for examples #### Reference -See https://plotly.com/python/reference/#layout-updatemenus for more information about `updatemenu` buttons. +See https://plotly.com/python/reference/layout/updatemenus/ for more information about `updatemenu` buttons. diff --git a/doc/python/dot-plots.md b/doc/python/dot-plots.md index bd0eea5128b..5f079809023 100644 --- a/doc/python/dot-plots.md +++ b/doc/python/dot-plots.md @@ -158,4 +158,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#scatter for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/dropdowns.md b/doc/python/dropdowns.md index 58e488192b8..9aae4fd1ce0 100644 --- a/doc/python/dropdowns.md +++ b/doc/python/dropdowns.md @@ -34,7 +34,7 @@ jupyter: --- #### Methods -The [updatemenu method](https://plotly.com/python/reference/#layout-updatemenus-buttons-method) determines which [plotly.js function](https://plotly.com/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods: +The [updatemenu method](https://plotly.com/python/reference/layout/updatemenus/#layout-updatemenus-buttons-method) determines which [plotly.js function](https://plotly.com/javascript/plotlyjs-function-reference/) will be used to modify the chart. There are 4 possible methods: - `"restyle"`: modify data or data attributes - `"relayout"`: modify layout attributes - `"update"`: modify data **and** layout attributes @@ -445,4 +445,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#layout-updatemenus for more information about `updatemenu` dropdowns. +See https://plotly.com/python/reference/layout/updatemenus/ for more information about `updatemenu` dropdowns. diff --git a/doc/python/error-bars.md b/doc/python/error-bars.md index c502d34a21a..3752f0cc539 100644 --- a/doc/python/error-bars.md +++ b/doc/python/error-bars.md @@ -202,4 +202,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/figure-labels.md b/doc/python/figure-labels.md index 72453620ada..332b5443b71 100644 --- a/doc/python/figure-labels.md +++ b/doc/python/figure-labels.md @@ -126,7 +126,7 @@ fig.show() The configuration of the legend is discussed in detail in the [Legends](/python/legend/) page. ### Align Plot Title -The following example shows how to align the plot title in [layout.title](https://plotly.com/python/reference/#layout-title). `x` sets the x position with respect to `xref` from "0" (left) to "1" (right), and `y` sets the y position with respect to `yref` from "0" (bottom) to "1" (top). Moreover, you can define `xanchor` to `left`,`right`, or `center` for setting the title's horizontal alignment with respect to its x position, and/or `yanchor` to `top`, `bottom`, or `middle` for setting the title's vertical alignment with respect to its y position. +The following example shows how to align the plot title in [layout.title](https://plotly.com/python/reference/layout/#layout-title). `x` sets the x position with respect to `xref` from "0" (left) to "1" (right), and `y` sets the y position with respect to `yref` from "0" (bottom) to "1" (top). Moreover, you can define `xanchor` to `left`,`right`, or `center` for setting the title's horizontal alignment with respect to its x position, and/or `yanchor` to `top`, `bottom`, or `middle` for setting the title's vertical alignment with respect to its y position. ```python import plotly.graph_objects as go @@ -147,4 +147,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#layout for more information! +See https://plotly.com/python/reference/layout/ for more information! diff --git a/doc/python/filled-area-on-mapbox.md b/doc/python/filled-area-on-mapbox.md index e59c432f55c..0db09233d9e 100644 --- a/doc/python/filled-area-on-mapbox.md +++ b/doc/python/filled-area-on-mapbox.md @@ -41,8 +41,8 @@ To plot on Mapbox maps with Plotly you _may_ need a Mapbox account and a public There are three different ways to show a filled area in a Mapbox map: -1. Use a [Scattermapbox](https://plotly.com/python/reference/#scattermapbox) trace and set `fill` attribute to 'toself' -2. Use a Mapbox layout (i.e. by minimally using an empty [Scattermapbox](https://plotly.com/python/reference/#scattermapbox) trace) and add a GeoJSON layer +1. Use a [Scattermapbox](https://plotly.com/python/reference/scattermapbox/) trace and set `fill` attribute to 'toself' +2. Use a Mapbox layout (i.e. by minimally using an empty [Scattermapbox](https://plotly.com/python/reference/scattermapbox/) trace) and add a GeoJSON layer 3. Use the [Choroplethmapbox](https://plotly.com/python/mapbox-county-choropleth/) trace type @@ -70,7 +70,7 @@ fig.show() ### Multiple Filled Areas with a `Scattermapbox` trace -The following example shows how to use `None` in your data to draw multiple filled areas. Such gaps in trace data are unconnected by default, but this can be controlled via the [connectgaps](https://plotly.com/python/reference/#scattermapbox-connectgaps) attribute. +The following example shows how to use `None` in your data to draw multiple filled areas. Such gaps in trace data are unconnected by default, but this can be controlled via the [connectgaps](https://plotly.com/python/reference/scattermapbox/#scattermapbox-connectgaps) attribute. ```python import plotly.graph_objects as go @@ -141,4 +141,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scattermapbox for more information about mapbox and their attribute options. \ No newline at end of file +See https://plotly.com/python/reference/scattermapbox/ for more information about mapbox and their attribute options. \ No newline at end of file diff --git a/doc/python/filled-area-plots.md b/doc/python/filled-area-plots.md index d648cbd7154..b93ba0f8b07 100644 --- a/doc/python/filled-area-plots.md +++ b/doc/python/filled-area-plots.md @@ -210,6 +210,6 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter-line -and https://plotly.com/python/reference/#scatter-fill +See https://plotly.com/python/reference/scatter/#scatter-line +and https://plotly.com/python/reference/scatter/#scatter-fill for more information and attribute options! \ No newline at end of file diff --git a/doc/python/funnel-charts.md b/doc/python/funnel-charts.md index 0f31b31299a..cc21babcbc2 100644 --- a/doc/python/funnel-charts.md +++ b/doc/python/funnel-charts.md @@ -74,7 +74,7 @@ fig.show() ### Setting Marker Size and Color -This example uses [textposition](https://plotly.com/python/reference/#scatter-textposition) and [textinfo](https://plotly.com/python/reference/#funnel-textinfo) to determine information apears on the graph, and shows how to customize the bars. +This example uses [textposition](https://plotly.com/python/reference/scatter/#scatter-textposition) and [textinfo](https://plotly.com/python/reference/funnel/#funnel-textinfo) to determine information apears on the graph, and shows how to customize the bars. ```python from plotly import graph_objects as go @@ -202,4 +202,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#funnel and https://plotly.com/python/reference/#funnelarea for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/funnel/ and https://plotly.com/python/reference/funnelarea/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/gauge-charts.md b/doc/python/gauge-charts.md index 8b206003a62..5800acc9630 100644 --- a/doc/python/gauge-charts.md +++ b/doc/python/gauge-charts.md @@ -78,7 +78,7 @@ fig.show() ``` #### Custom Gauge Chart -The following example shows how to style your gauge charts. For more information about all possible options check our [reference page](https://plotly.com/python/reference/#indicator). +The following example shows how to style your gauge charts. For more information about all possible options check our [reference page](https://plotly.com/python/reference/indicator/). ```python import plotly.graph_objects as go @@ -110,4 +110,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#indicator for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/indicator/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/heatmaps.md b/doc/python/heatmaps.md index e5b0386bc10..1801c04d96e 100644 --- a/doc/python/heatmaps.md +++ b/doc/python/heatmaps.md @@ -89,7 +89,7 @@ fig.show() ### Heatmap with Categorical Axis Labels -In this example we also show how to ignore [hovertext](https://plotly.com/python/hover-text-and-formatting/) when we have [missing values](https://plotly.com/python/missing_values) in the data by setting the [hoverongaps](https://plotly.com/python/reference/#heatmap-hoverongaps) to False. +In this example we also show how to ignore [hovertext](https://plotly.com/python/hover-text-and-formatting/) when we have [missing values](https://plotly.com/python/missing_values) in the data by setting the [hoverongaps](https://plotly.com/python/reference/heatmap/#heatmap-hoverongaps) to False. ```python import plotly.graph_objects as go @@ -190,4 +190,4 @@ Arrays of rasterized values build by datashader can be visualized using plotly's heatmaps, as shown in the [plotly and datashader tutorial](/python/datashader/). #### Reference -See https://plotly.com/python/reference/#heatmap for more information and chart attribute options! +See https://plotly.com/python/reference/heatmap/ for more information and chart attribute options! diff --git a/doc/python/histograms.md b/doc/python/histograms.md index c0aedf7f44a..7f37432390e 100644 --- a/doc/python/histograms.md +++ b/doc/python/histograms.md @@ -306,7 +306,7 @@ fig.show() ### Custom Binning -For custom binning along x-axis, use the attribute [`nbinsx`](https://plotly.com/python/reference/#histogram-nbinsx). Please note that the autobin algorithm will choose a 'nice' round bin size that may result in somewhat fewer than `nbinsx` total bins. Alternatively, you can set the exact values for [`xbins`](https://plotly.com/python/reference/#histogram-xbins) along with `autobinx = False`. +For custom binning along x-axis, use the attribute [`nbinsx`](https://plotly.com/python/reference/histogram/#histogram-nbinsx). Please note that the autobin algorithm will choose a 'nice' round bin size that may result in somewhat fewer than `nbinsx` total bins. Alternatively, you can set the exact values for [`xbins`](https://plotly.com/python/reference/histogram/#histogram-xbins) along with `autobinx = False`. ```python import plotly.graph_objects as go @@ -369,7 +369,7 @@ fig2.show() ### Share bins between histograms -In this example both histograms have a compatible bin settings using [bingroup](https://plotly.com/python/reference/#histogram-bingroup) attribute. Note that traces on the same subplot, and with the same `barmode` ("stack", "relative", "group") are forced into the same `bingroup`, however traces with `barmode = "overlay"` and on different axes (of the same axis type) can have compatible bin settings. Histogram and [histogram2d](https://plotly.com/python/2D-Histogram/) trace can share the same `bingroup`. +In this example both histograms have a compatible bin settings using [bingroup](https://plotly.com/python/reference/histogram/#histogram-bingroup) attribute. Note that traces on the same subplot, and with the same `barmode` ("stack", "relative", "group") are forced into the same `bingroup`, however traces with `barmode = "overlay"` and on different axes (of the same axis type) can have compatible bin settings. Histogram and [histogram2d](https://plotly.com/python/2D-Histogram/) trace can share the same `bingroup`. ```python import plotly.graph_objects as go @@ -392,4 +392,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#histogram for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/histogram/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/horizontal-bar-charts.md b/doc/python/horizontal-bar-charts.md index b69a6e241b7..25aa9d4f7d1 100644 --- a/doc/python/horizontal-bar-charts.md +++ b/doc/python/horizontal-bar-charts.md @@ -64,7 +64,7 @@ fig.show() ### Horizontal Bar Chart with go.Bar -You can also use [the more generic `go.Bar` class from `plotly.graph_objects`](/python/graph-objects/). All the options of `go.Bar` are documented in the reference https://plotly.com/python/reference/#bar +You can also use [the more generic `go.Bar` class from `plotly.graph_objects`](/python/graph-objects/). All the options of `go.Bar` are documented in the reference https://plotly.com/python/reference/bar/ #### Basic Horizontal Bar Chart @@ -335,4 +335,4 @@ fig.show() ### Reference -See more examples of bar charts and styling options [here](https://plotly.com/python/bar-charts/).
See https://plotly.com/python/reference/#bar for more information and chart attribute options! \ No newline at end of file +See more examples of bar charts and styling options [here](https://plotly.com/python/bar-charts/).
See https://plotly.com/python/reference/bar/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/hover-text-and-formatting.md b/doc/python/hover-text-and-formatting.md index 1f9a0a475c3..87db668c665 100644 --- a/doc/python/hover-text-and-formatting.md +++ b/doc/python/hover-text-and-formatting.md @@ -169,12 +169,12 @@ fig.show() ### Customizing hover text with a hovertemplate -To customize the tooltip on your graph you can use the [hovertemplate](https://plotly.com/python/reference/#pie-hovertemplate) attribute of `graph_objects` tracces, which is a template string used for rendering the information that appear on hoverbox. +To customize the tooltip on your graph you can use the [hovertemplate](https://plotly.com/python/reference/pie/#pie-hovertemplate) attribute of `graph_objects` tracces, which is a template string used for rendering the information that appear on hoverbox. This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format). In the example below, the empty `` tag removes the part of the hover where the trace name is usually displayed in a contrasting color. The `` tag can be used to display other parts of the hovertemplate, it is not reserved for the trace name. -Note that a hovertemplate customizes the tooltip text, while a [texttemplate](https://plotly.com/python/reference/#pie-texttemplate) customizes the text that appears on your chart.
+Note that a hovertemplate customizes the tooltip text, while a [texttemplate](https://plotly.com/python/reference/pie/#pie-texttemplate) customizes the text that appears on your chart.
-Set the horizontal alignment of the text within tooltip with [hoverlabel.align](https://plotly.com/python/reference/#layout-hoverlabel-align). +Set the horizontal alignment of the text within tooltip with [hoverlabel.align](https://plotly.com/python/reference/layout/#layout-hoverlabel-align). ```python import plotly.graph_objects as go diff --git a/doc/python/images.md b/doc/python/images.md index 5985e88a537..e4e72c5cfe0 100644 --- a/doc/python/images.md +++ b/doc/python/images.md @@ -360,4 +360,4 @@ fig.show(config={'modeBarButtonsToAdd':['drawline', ``` #### Reference -See https://plotly.com/python/reference/#layout-images for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/layout/images/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/imshow.md b/doc/python/imshow.md index a63c413b56f..7e74f794f8d 100644 --- a/doc/python/imshow.md +++ b/doc/python/imshow.md @@ -308,4 +308,4 @@ fig.show(config={'modeBarButtonsToAdd':['drawline', ``` #### Reference -See https://plotly.com/python/reference/#image for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/image/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/indicator.md b/doc/python/indicator.md index a28c8734d1c..276bceaf74c 100644 --- a/doc/python/indicator.md +++ b/doc/python/indicator.md @@ -202,7 +202,7 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#indicator for more information and chart attribute options! +See https://plotly.com/python/reference/indicator/ for more information and chart attribute options! ```python diff --git a/doc/python/legend.md b/doc/python/legend.md index 708af3fd55d..72ae618b270 100644 --- a/doc/python/legend.md +++ b/doc/python/legend.md @@ -248,7 +248,7 @@ fig.show() #### Size of Legend Items -In this example [itemsizing](https://plotly.com/python/reference/#layout-legend-itemsizing) attribute determines the legend items symbols remain constant, regardless of how tiny/huge the bubbles would be in the graph. +In this example [itemsizing](https://plotly.com/python/reference/layout/#layout-legend-itemsizing) attribute determines the legend items symbols remain constant, regardless of how tiny/huge the bubbles would be in the graph. ```python import plotly.graph_objects as go @@ -419,4 +419,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#layout-legend for more information! +See https://plotly.com/python/reference/layout/#layout-legend for more information! diff --git a/doc/python/line-and-scatter.md b/doc/python/line-and-scatter.md index e11e9bfcb32..0bc34dbf84a 100644 --- a/doc/python/line-and-scatter.md +++ b/doc/python/line-and-scatter.md @@ -88,7 +88,7 @@ fig.show() ## Scatter and line plot with go.Scatter -If Plotly Express does not provide a good starting point, it is possible to use [the more generic `go.Scatter` class from `plotly.graph_objects`](/python/graph-objects/). Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plotly.com/python/reference/#scatter). +If Plotly Express does not provide a good starting point, it is possible to use [the more generic `go.Scatter` class from `plotly.graph_objects`](/python/graph-objects/). Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plotly.com/python/reference/scatter/). #### Simple Scatter Plot @@ -276,4 +276,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#scatter or https://plotly.com/python/reference/#scattergl for more information and chart attribute options! +See https://plotly.com/python/reference/scatter/ or https://plotly.com/python/reference/scattergl/ for more information and chart attribute options! diff --git a/doc/python/line-charts.md b/doc/python/line-charts.md index f335054be0c..02d4c9569a8 100644 --- a/doc/python/line-charts.md +++ b/doc/python/line-charts.md @@ -98,7 +98,7 @@ fig.show(config=dict(displayModeBar=False)) ### Line Plot with go.Scatter -If Plotly Express does not provide a good starting point, it is possible to use [the more generic `go.Scatter` class from `plotly.graph_objects`](/python/graph-objects/). Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plotly.com/python/reference/#scatter). +If Plotly Express does not provide a good starting point, it is possible to use [the more generic `go.Scatter` class from `plotly.graph_objects`](/python/graph-objects/). Whereas `plotly.express` has two functions `scatter` and `line`, `go.Scatter` can be used both for plotting points (makers) or lines, depending on the value of `mode`. The different options of `go.Scatter` are documented in its [reference page](https://plotly.com/python/reference/scatter/). #### Simple Line Plot @@ -187,7 +187,7 @@ fig.show() #### Connect Data Gaps -[connectgaps](https://plotly.com/python/reference/#scatter-connectgaps) determines if missing values in the provided data are shown as a gap in the graph or not. In [this tutorial](https://plotly.com/python/filled-area-on-mapbox/#multiple-filled-areas-with-a-scattermapbox-trace), we showed how to take benefit of this feature and illustrate multiple areas in mapbox. +[connectgaps](https://plotly.com/python/reference/scatter/#scatter-connectgaps) determines if missing values in the provided data are shown as a gap in the graph or not. In [this tutorial](https://plotly.com/python/filled-area-on-mapbox/#multiple-filled-areas-with-a-scattermapbox-trace), we showed how to take benefit of this feature and illustrate multiple areas in mapbox. ```python import plotly.graph_objects as go @@ -434,4 +434,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter for more information and chart attribute options! +See https://plotly.com/python/reference/scatter/ for more information and chart attribute options! diff --git a/doc/python/lines-on-mapbox.md b/doc/python/lines-on-mapbox.md index 2f36f0daeb5..72abbdf8970 100644 --- a/doc/python/lines-on-mapbox.md +++ b/doc/python/lines-on-mapbox.md @@ -37,7 +37,7 @@ jupyter: To plot on Mapbox maps with Plotly you _may_ need a Mapbox account and a public [Mapbox Access Token](https://www.mapbox.com/studio). See our [Mapbox Map Layers](/python/mapbox-layers/) documentation for more information. -To draw a line on your map, you either can use [`px.line_mapbox()`](https://www.plotly.express/plotly_express/#plotly_express.line_mapbox) in Plotly Express, or [`Scattermapbox`](https://plotly.com/python/reference/#scattermapbox) traces. Below we show you how to draw a line on Mapbox using Plotly Express. +To draw a line on your map, you either can use [`px.line_mapbox()`](https://www.plotly.express/plotly_express/#plotly_express.line_mapbox) in Plotly Express, or [`Scattermapbox`](https://plotly.com/python/reference/scattermapbox/) traces. Below we show you how to draw a line on Mapbox using Plotly Express. ### Lines on Mapbox maps using Plotly Express @@ -60,7 +60,7 @@ fig.show() ### Lines on Mapbox maps using `Scattermapbox` traces This example uses `go.Scattermapbox` and sets -the [mode](https://plotly.com/python/reference/#scattermapbox-mode) attribute to a combination of markers and line. +the [mode](https://plotly.com/python/reference/scattermapbox/#scattermapbox-mode) attribute to a combination of markers and line. ```python import plotly.graph_objects as go @@ -90,4 +90,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scattermapbox for more information about mapbox and their attribute options. \ No newline at end of file +See https://plotly.com/python/reference/scattermapbox/ for more information about mapbox and their attribute options. \ No newline at end of file diff --git a/doc/python/lines-on-maps.md b/doc/python/lines-on-maps.md index 3bf41f50b39..c95390171b4 100644 --- a/doc/python/lines-on-maps.md +++ b/doc/python/lines-on-maps.md @@ -289,4 +289,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scattergeo for more information and chart attribute options! +See https://plotly.com/python/reference/scattergeo/ for more information and chart attribute options! diff --git a/doc/python/log-plot.md b/doc/python/log-plot.md index c35747869e7..3a21e7fed8b 100644 --- a/doc/python/log-plot.md +++ b/doc/python/log-plot.md @@ -54,4 +54,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#layout-xaxis-type for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-type for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/map-configuration.md b/doc/python/map-configuration.md index 65e506456cc..5a2f5a349f6 100644 --- a/doc/python/map-configuration.md +++ b/doc/python/map-configuration.md @@ -220,7 +220,7 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#layout-geo for more information and chart attribute options! +See https://plotly.com/python/reference/layout/geo/ for more information and chart attribute options! ```python diff --git a/doc/python/map-subplots-and-small-multiples.md b/doc/python/map-subplots-and-small-multiples.md index 89c51085645..d9f8a054732 100644 --- a/doc/python/map-subplots-and-small-multiples.md +++ b/doc/python/map-subplots-and-small-multiples.md @@ -162,5 +162,5 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#scattergeo for more information and chart attribute options! +See https://plotly.com/python/reference/scattergeo/ for more information and chart attribute options! diff --git a/doc/python/mapbox-county-choropleth.md b/doc/python/mapbox-county-choropleth.md index e7ee6d77097..54458d072e7 100644 --- a/doc/python/mapbox-county-choropleth.md +++ b/doc/python/mapbox-county-choropleth.md @@ -209,4 +209,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#choroplethmapbox for more information about mapbox and their attribute options. \ No newline at end of file +See https://plotly.com/python/reference/choroplethmapbox/ for more information about mapbox and their attribute options. \ No newline at end of file diff --git a/doc/python/mapbox-density-heatmaps.md b/doc/python/mapbox-density-heatmaps.md index d836db16d24..ea7fac66728 100644 --- a/doc/python/mapbox-density-heatmaps.md +++ b/doc/python/mapbox-density-heatmaps.md @@ -72,4 +72,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#densitymapbox for more information about mapbox and their attribute options. \ No newline at end of file +See https://plotly.com/python/reference/densitymapbox/ for more information about mapbox and their attribute options. \ No newline at end of file diff --git a/doc/python/mapbox-layers.md b/doc/python/mapbox-layers.md index cfd2e853d01..c0409d18310 100644 --- a/doc/python/mapbox-layers.md +++ b/doc/python/mapbox-layers.md @@ -191,4 +191,4 @@ See the example in the [plotly and datashader tutorial](/python/datashader). #### Reference -See https://plotly.com/python/reference/#layout-mapbox for more information and options! \ No newline at end of file +See https://plotly.com/python/reference/layout/mapbox/ for more information and options! \ No newline at end of file diff --git a/doc/python/multiple-axes.md b/doc/python/multiple-axes.md index f9956231285..76a88824dad 100644 --- a/doc/python/multiple-axes.md +++ b/doc/python/multiple-axes.md @@ -233,4 +233,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/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 index 33b9c5c7ee6..f6dae5c338c 100644 --- a/doc/python/network-graphs.md +++ b/doc/python/network-graphs.md @@ -146,4 +146,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatter for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatter/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/ohlc-charts.md b/doc/python/ohlc-charts.md index 81aa5589076..dc6e02ed1f3 100644 --- a/doc/python/ohlc-charts.md +++ b/doc/python/ohlc-charts.md @@ -155,4 +155,4 @@ fig.show() ``` #### Reference -For more information on candlestick attributes, see: https://plotly.com/python/reference/#ohlc \ No newline at end of file +For more information on candlestick attributes, see: https://plotly.com/python/reference/ohlc/ \ No newline at end of file diff --git a/doc/python/parallel-categories-diagram.md b/doc/python/parallel-categories-diagram.md index ac9ae57a4fa..ee8a887c47e 100644 --- a/doc/python/parallel-categories-diagram.md +++ b/doc/python/parallel-categories-diagram.md @@ -288,4 +288,4 @@ widgets.VBox([color_toggle, fig]) #### Reference -See [reference page](https://plotly.com/python/reference/#parcats) for more information and chart attribute options! \ No newline at end of file +See [reference page](https://plotly.com/python/reference/parcats/) for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/parallel-coordinates-plot.md b/doc/python/parallel-coordinates-plot.md index 74a41ec5204..1cec76fd908 100644 --- a/doc/python/parallel-coordinates-plot.md +++ b/doc/python/parallel-coordinates-plot.md @@ -173,4 +173,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#parcoords for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/parcoords/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/pie-charts.md b/doc/python/pie-charts.md index b125011753c..1899fe7be31 100644 --- a/doc/python/pie-charts.md +++ b/doc/python/pie-charts.md @@ -304,4 +304,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#pie for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/pie/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/polar-chart.md b/doc/python/polar-chart.md index e60f6ff5b25..e630febb903 100644 --- a/doc/python/polar-chart.md +++ b/doc/python/polar-chart.md @@ -85,7 +85,7 @@ fig.show() ## Polar Scatter Plot with go.Scatterpolar -If Plotly Express does not provide a good starting point, you can use [the more generic `go.Scatterpolar` class from `plotly.graph_objects`](/python/graph-objects/). All the options are documented in the [reference page](https://plotly.com/python/reference/#scatterpolar). +If Plotly Express does not provide a good starting point, you can use [the more generic `go.Scatterpolar` class from `plotly.graph_objects`](/python/graph-objects/). All the options are documented in the [reference page](https://plotly.com/python/reference/scatterpolar/). #### Basic Polar Chart @@ -438,4 +438,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatterpolar for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatterpolar/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/radar-chart.md b/doc/python/radar-chart.md index c0dff274903..92228e15c89 100644 --- a/doc/python/radar-chart.md +++ b/doc/python/radar-chart.md @@ -129,4 +129,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scatterpolar for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatterpolar/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/range-slider.md b/doc/python/range-slider.md index e3437e16f97..9d1bce3bde6 100644 --- a/doc/python/range-slider.md +++ b/doc/python/range-slider.md @@ -342,4 +342,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#layout-xaxis-rangeselector
and https://plotly.com/python/reference/#layout-xaxis-rangeslider
for more information and attribute options! +See https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-rangeselector
and https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-rangeslider
for more information and attribute options! diff --git a/doc/python/sankey-diagram.md b/doc/python/sankey-diagram.md index cf6bfbfc3ce..59c2ebe9c18 100644 --- a/doc/python/sankey-diagram.md +++ b/doc/python/sankey-diagram.md @@ -39,7 +39,7 @@ A [Sankey diagram](https://en.wikipedia.org/wiki/Sankey_diagram) is a flow diagr ### Basic Sankey Diagram -Sankey diagrams visualize the contributions to a flow by defining [source](https://plotly.com/python/reference/#sankey-link-source) to represent the source node, [target](https://plotly.com/python/reference/#sankey-link-target) for the target node, [value](https://plotly.com/python/reference/#sankey-link-value) to set the flow volum, and [label](https://plotly.com/python/reference/#sankey-node-label) that shows the node name. +Sankey diagrams visualize the contributions to a flow by defining [source](https://plotly.com/python/reference/sankey/#sankey-link-source) to represent the source node, [target](https://plotly.com/python/reference/sankey/#sankey-link-target) for the target node, [value](https://plotly.com/python/reference/sankey/#sankey-link-value) to set the flow volum, and [label](https://plotly.com/python/reference/sankey/#sankey-node-label) that shows the node name. ```python import plotly.graph_objects as go @@ -105,7 +105,7 @@ fig.show() ``` ### Style Sankey Diagram -This example also uses [hovermode](https://plotly.com/python/reference/#layout-hovermode) to enable multiple tooltips. +This example also uses [hovermode](https://plotly.com/python/reference/layout/#layout-hovermode) to enable multiple tooltips. ```python import plotly.graph_objects as go @@ -177,7 +177,7 @@ fig.show() ### Define Node Position -The following example sets [node.x](https://plotly.com/python/reference/#sankey-node-x) and `node.y` to place nodes in the specified locations, except in the `snap arrangement` (default behaviour when `node.x` and `node.y` are not defined) to avoid overlapping of the nodes, therefore, an automatic snapping of elements will be set to define the padding between nodes via [nodepad](https://plotly.com/python/reference/#sankey-node-pad). The other possible arrangements are: 1) perpendicular 2) freeform 3) fixed +The following example sets [node.x](https://plotly.com/python/reference/sankey/#sankey-node-x) and `node.y` to place nodes in the specified locations, except in the `snap arrangement` (default behaviour when `node.x` and `node.y` are not defined) to avoid overlapping of the nodes, therefore, an automatic snapping of elements will be set to define the padding between nodes via [nodepad](https://plotly.com/python/reference/sankey/#sankey-node-pad). The other possible arrangements are: 1) perpendicular 2) freeform 3) fixed ```python import plotly.graph_objects as go @@ -199,4 +199,4 @@ fig.show() ### Reference -See [https://plotly.com/python/reference/#sankey](https://plotly.com/python/reference/#sankey) for more information and options! \ No newline at end of file +See [https://plotly.com/python/reference/sankey](https://plotly/.com/python/reference/sankey/) for more information and options! \ No newline at end of file diff --git a/doc/python/scatter-plots-on-maps.md b/doc/python/scatter-plots-on-maps.md index 46a86a8e07b..741d2742681 100644 --- a/doc/python/scatter-plots-on-maps.md +++ b/doc/python/scatter-plots-on-maps.md @@ -214,4 +214,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scattergeo and https://plotly.com/python/reference/#layout-geo for more information and chart attribute options! +See https://plotly.com/python/reference/scattergeo/ and https://plotly.com/python/reference/layout/geo/ for more information and chart attribute options! diff --git a/doc/python/scattermapbox.md b/doc/python/scattermapbox.md index f658f6abd8a..41f09f8c721 100644 --- a/doc/python/scattermapbox.md +++ b/doc/python/scattermapbox.md @@ -196,7 +196,7 @@ fig.show() ### Set Marker Symbols -You can define a symbol on your map by setting [symbol](https://plotly.com/python/reference/#scattermapbox-marker-symbol) attribute. This attribute only works on Mapbox-provided `style`s: +You can define a symbol on your map by setting [symbol](https://plotly.com/python/reference/scattermapbox/#scattermapbox-marker-symbol) attribute. This attribute only works on Mapbox-provided `style`s: - basic - streets @@ -228,4 +228,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#scattermapbox for more information and options! \ No newline at end of file +See https://plotly.com/python/reference/scattermapbox/ for more information and options! \ No newline at end of file diff --git a/doc/python/setting-graph-size.md b/doc/python/setting-graph-size.md index eec65ae6707..c3c07a6c507 100644 --- a/doc/python/setting-graph-size.md +++ b/doc/python/setting-graph-size.md @@ -84,7 +84,7 @@ fig.show() ### Automatically Adjust Margins -Set [automargin](https://plotly.com/python/reference/#layout-xaxis-automargin) to `True` and Plotly will automatically increase the margin size to prevent ticklabels from being cut off or overlapping with axis titles. +Set [automargin](https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-automargin) to `True` and Plotly will automatically increase the margin size to prevent ticklabels from being cut off or overlapping with axis titles. ```python import plotly.graph_objects as go @@ -117,4 +117,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#layout for more information and chart attribute options! +See https://plotly.com/python/reference/layout/ for more information and chart attribute options! diff --git a/doc/python/shapes.md b/doc/python/shapes.md index 10653522935..0c229ea89cc 100644 --- a/doc/python/shapes.md +++ b/doc/python/shapes.md @@ -35,7 +35,7 @@ jupyter: ### Filled Area Chart -There are two ways to draw filled shapes: scatter traces and [layout.shapes](https://plotly.com/python/reference/#layout-shapes-items-shape-type) which is mostly useful for the 2d subplots, and defines the shape type to be drawn, and can be rectangle, circle, line, or path (a custom SVG path). You also can use [scatterpolar](https://plotly.com/python/polar-chart/#categorical-polar-chart), scattergeo, [scattermapbox](https://plotly.com/python/filled-area-on-mapbox/#filled-scattermapbox-trace) to draw filled shapes on any kind of subplots. To set an area to be filled with a solid color, you need to define [Scatter.fill="toself"](https://plotly.com/python/reference/#scatter-fill) that connects the endpoints of the trace into a closed shape. If `mode=line` (default value), then you need to repeat the initial point of a shape at the of the sequence to have a closed shape. +There are two ways to draw filled shapes: scatter traces and [layout.shapes](https://plotly.com/python/reference/layout/shapes/#layout-shapes-items-shape-type) which is mostly useful for the 2d subplots, and defines the shape type to be drawn, and can be rectangle, circle, line, or path (a custom SVG path). You also can use [scatterpolar](https://plotly.com/python/polar-chart/#categorical-polar-chart), scattergeo, [scattermapbox](https://plotly.com/python/filled-area-on-mapbox/#filled-scattermapbox-trace) to draw filled shapes on any kind of subplots. To set an area to be filled with a solid color, you need to define [Scatter.fill="toself"](https://plotly.com/python/reference/scatter/#scatter-fill) that connects the endpoints of the trace into a closed shape. If `mode=line` (default value), then you need to repeat the initial point of a shape at the of the sequence to have a closed shape. ```python import plotly.graph_objects as go @@ -803,4 +803,4 @@ fig.show(config={'modeBarButtonsToAdd':['drawline', ``` ### Reference -See https://plotly.com/python/reference/#layout-shapes for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/layout/shapes/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/sliders.md b/doc/python/sliders.md index aae9f1db7f7..a46cfd94d3a 100644 --- a/doc/python/sliders.md +++ b/doc/python/sliders.md @@ -82,7 +82,7 @@ fig.show() ``` #### Methods -The method determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to update the chart. Plotly can use several [updatemenu](https://plot.ly/python/reference/#layout-updatemenus-items-updatemenu-buttons-items-button-method) methods to add the slider: +The method determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to update the chart. Plotly can use several [updatemenu](https://plot.ly/python/reference/layout/updatemenus/#layout-updatemenus-items-updatemenu-buttons-items-button-method) methods to add the slider: - `"update"`: modify **data and layout** attributes (as above) - `"restyle"`: modify **data** attributes - `"relayout"`: modify **layout** attributes @@ -105,4 +105,4 @@ fig.show() ``` #### Reference -Check out https://plotly.com/python/reference/#layout-updatemenus for more information! +Check out https://plotly.com/python/reference/layout/updatemenus/ for more information! diff --git a/doc/python/splom.md b/doc/python/splom.md index bbbff2ef8df..488fca90af6 100644 --- a/doc/python/splom.md +++ b/doc/python/splom.md @@ -81,7 +81,7 @@ fig.show() ### Scatter matrix (splom) with go.Splom -If Plotly Express does not provide a good starting point, it is possible to use [the more generic `go.Splom` class from `plotly.graph_objects`](/python/graph-objects/). All its parameters are documented in the reference page https://plotly.com/python/reference/#splom. +If Plotly Express does not provide a good starting point, it is possible to use [the more generic `go.Splom` class from `plotly.graph_objects`](/python/graph-objects/). All its parameters are documented in the reference page https://plotly.com/python/reference/splom/. The Plotly splom trace implementation for the scatterplot matrix does not require to set $x=Xi$ , and $y=Xj$, for each scatter plot. All arrays, $X_1,X_2,…,X_n$ , are passed once, through a list of dicts called dimensions, i.e. each array/variable represents a dimension. diff --git a/doc/python/streamtube-plot.md b/doc/python/streamtube-plot.md index 6bb9941a287..a211753d27a 100644 --- a/doc/python/streamtube-plot.md +++ b/doc/python/streamtube-plot.md @@ -130,4 +130,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#streamtube for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/streamtube/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/subplots.md b/doc/python/subplots.md index c1cfb6dc9c9..a20c03abdfd 100644 --- a/doc/python/subplots.md +++ b/doc/python/subplots.md @@ -307,7 +307,7 @@ fig.show() ### Subplots with Shared Colorscale -To share colorscale information in multiple subplots, you can use [coloraxis](https://plotly.com/javascript/reference/#scatter-marker-line-coloraxis). +To share colorscale information in multiple subplots, you can use [coloraxis](https://plotly.com/javascript/reference/scatter/#scatter-marker-line-coloraxis). ```python from plotly.subplots import make_subplots @@ -582,8 +582,8 @@ fig.show() ``` #### 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/XAxis/ +All of the y-axis properties are found here: https://plotly.com/python/reference/YAxis/ ```python from plotly.subplots import make_subplots diff --git a/doc/python/sunburst-charts.md b/doc/python/sunburst-charts.md index 7882d2d57a8..1d731734877 100644 --- a/doc/python/sunburst-charts.md +++ b/doc/python/sunburst-charts.md @@ -214,7 +214,7 @@ fig.show() ### Large Number of Slices -This example uses a [plotly grid attribute](https://plotly.com/python/reference/#layout-grid) for the suplots. Reference the row and column destination using the [domain](https://plotly.com/python/reference/#sunburst-domain) attribute. +This example uses a [plotly grid attribute](https://plotly.com/python/reference/layout/#layout-grid) for the suplots. Reference the row and column destination using the [domain](https://plotly.com/python/reference/sunburst/#sunburst-domain) attribute. ```python import plotly.graph_objects as go @@ -380,4 +380,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#sunburst for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/sunburst/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/table-subplots.md b/doc/python/table-subplots.md index c75ad0c5b13..d7000441ce5 100644 --- a/doc/python/table-subplots.md +++ b/doc/python/table-subplots.md @@ -103,5 +103,5 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#table for more information regarding chart attributes!
+See https://plotly.com/python/reference/table/ for more information regarding chart attributes!
For examples of Plotly Tables, see: https://plotly.com/python/table/ diff --git a/doc/python/table.md b/doc/python/table.md index 81c11e42429..378c91297f5 100644 --- a/doc/python/table.md +++ b/doc/python/table.md @@ -211,4 +211,4 @@ fig.show() ``` #### Reference -For more information on tables and table attributes see: https://plotly.com/python/reference/#table. \ No newline at end of file +For more information on tables and table attributes see: https://plotly.com/python/reference/table/. \ No newline at end of file diff --git a/doc/python/ternary-plots.md b/doc/python/ternary-plots.md index d92b9447583..95bea43fec7 100644 --- a/doc/python/ternary-plots.md +++ b/doc/python/ternary-plots.md @@ -126,4 +126,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#scatterternary for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scatterternary/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/text-and-annotations.md b/doc/python/text-and-annotations.md index 785138ea57e..e2686e9c325 100644 --- a/doc/python/text-and-annotations.md +++ b/doc/python/text-and-annotations.md @@ -536,9 +536,9 @@ fig.show() ### Customize Displayed Text with a Text Template -To show an arbitrary text in your chart you can use [texttemplate](https://plotly.com/python/reference/#pie-texttemplate), which is a template string used for rendering the information, and will override [textinfo](https://plotly.com/python/reference/#treemap-textinfo). +To show an arbitrary text in your chart you can use [texttemplate](https://plotly.com/python/reference/pie/#pie-texttemplate), which is a template string used for rendering the information, and will override [textinfo](https://plotly.com/python/reference/treemap/#treemap-textinfo). This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format). -`texttemplate` customizes the text that appears on your plot vs. [hovertemplate](https://plotly.com/python/reference/#pie-hovertemplate) that customizes the tooltip text. +`texttemplate` customizes the text that appears on your plot vs. [hovertemplate](https://plotly.com/python/reference/pie/#pie-hovertemplate) that customizes the tooltip text. ```python import plotly.graph_objects as go @@ -554,7 +554,7 @@ fig.show() ### Customize Text Template -The following example uses [textfont](https://plotly.com/python/reference/#scatterternary-textfont) to customize the added text. +The following example uses [textfont](https://plotly.com/python/reference/scatterternary/#scatterternary-textfont) to customize the added text. ```python import plotly.graph_objects as go @@ -575,8 +575,8 @@ fig.show() ### Set Date in Text Template -The following example shows how to show date by setting [axis.type](https://plotly.com/python/reference/#layout-yaxis-type) in [funnel charts](https://plotly.com/python/funnel-charts/). -As you can see [textinfo](https://plotly.com/python/reference/#funnel-textinfo) and [texttemplate](https://plotly.com/python/reference/#funnel-texttemplate) have the same functionality when you want to determine 'just' the trace information on the graph. +The following example shows how to show date by setting [axis.type](https://plotly.com/python/reference/layout/yaxis/#layout-yaxis-type) in [funnel charts](https://plotly.com/python/funnel-charts/). +As you can see [textinfo](https://plotly.com/python/reference/funnel/#funnel-textinfo) and [texttemplate](https://plotly.com/python/reference/funnel/#funnel-texttemplate) have the same functionality when you want to determine 'just' the trace information on the graph. ```python from plotly import graph_objects as go @@ -606,4 +606,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#layout-annotations for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/layout/annotations/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/tick-formatting.md b/doc/python/tick-formatting.md index 53c1ebd8578..5f07ed478e4 100644 --- a/doc/python/tick-formatting.md +++ b/doc/python/tick-formatting.md @@ -194,4 +194,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#layout-xaxis for more information and chart attribute options! +See https://plotly.com/python/reference/layout/xaxis/ for more information and chart attribute options! diff --git a/doc/python/time-series.md b/doc/python/time-series.md index 07f794be92c..4c900b0f204 100644 --- a/doc/python/time-series.md +++ b/doc/python/time-series.md @@ -110,7 +110,7 @@ fig.show() ### Time Series With Range Slider -A range slider is a small subplot-like area below a plot which allows users to pan and zoom the X-axis while maintaining an overview of the chart. Check out the reference for more options: https://plotly.com/python/reference/#layout-xaxis-rangeslider +A range slider is a small subplot-like area below a plot which allows users to pan and zoom the X-axis while maintaining an overview of the chart. Check out the reference for more options: https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-rangeslider ```python import plotly.express as px @@ -126,7 +126,7 @@ fig.show() ### Time Series with Range Selector Buttons -Range selector buttons are special controls that work well with time series and range sliders, and allow users to easily set the range of the x-axis. Check out the reference for more options: https://plotly.com/python/reference/#layout-xaxis-rangeselector +Range selector buttons are special controls that work well with time series and range sliders, and allow users to easily set the range of the x-axis. Check out the reference for more options: https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-rangeselector ```python import plotly.express as px @@ -153,7 +153,7 @@ fig.show() ### Customizing Tick Label Formatting by Zoom Level -The `tickformatstops` attribute can be used to customize the formatting of tick labels depending on the zoom level. Try zooming in to the chart below and see how the tick label formatting changes. Check out the reference for more options: https://plotly.com/python/reference/#layout-xaxis-tickformatstops +The `tickformatstops` attribute can be used to customize the formatting of tick labels depending on the zoom level. Try zooming in to the chart below and see how the tick label formatting changes. Check out the reference for more options: https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-tickformatstops ```python import plotly.graph_objects as go @@ -185,7 +185,7 @@ fig.show() ### Hiding Weekends and Holidays -The `rangebreaks` attribute available on x- and y-axes of type `date` can be used to hide certain time-periods. In the example below, we show two plots: one in default mode to show gaps in the data, and one where we hide weekends and holidays to show an uninterrupted trading history. Note the smaller gaps between the grid lines for December 21 and January 4, where holidays were removed. Check out the reference for more options: https://plotly.com/python/reference/#layout-xaxis-rangebreaks +The `rangebreaks` attribute available on x- and y-axes of type `date` can be used to hide certain time-periods. In the example below, we show two plots: one in default mode to show gaps in the data, and one where we hide weekends and holidays to show an uninterrupted trading history. Note the smaller gaps between the grid lines for December 21 and January 4, where holidays were removed. Check out the reference for more options: https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-rangebreaks > Note: a known limitation of this feature is that it does not support `scattergl` traces. When using this feature on plots with more than a few hundred data points with `px.scatter` or `px.line` or `px.area`, you may need to pass in `render_mode="svg"` to ensure that the underlying trace type is `scatter` and not `scattergl`. diff --git a/doc/python/treemaps.md b/doc/python/treemaps.md index 5da558ac37f..8fdb359757f 100644 --- a/doc/python/treemaps.md +++ b/doc/python/treemaps.md @@ -33,7 +33,7 @@ jupyter: thumbnail: thumbnail/treemap.png --- -[Treemap charts](https://en.wikipedia.org/wiki/Treemapping) visualize hierarchical data using nested rectangles. Same as [Sunburst](https://plotly.com/python/sunburst-charts/) the hierarchy is defined by [labels](https://plotly.com/python/reference/#treemap-labels) (`names` for `px.treemap`) and [parents](https://plotly.com/python/reference/#treemap-parents) attributes. Click on one sector to zoom in/out, which also displays a pathbar in the upper-left corner of your treemap. To zoom out you can use the path bar as well. +[Treemap charts](https://en.wikipedia.org/wiki/Treemapping) visualize hierarchical data using nested rectangles. Same as [Sunburst](https://plotly.com/python/sunburst-charts/) the hierarchy is defined by [labels](https://plotly.com/python/reference/treemap/#treemap-labels) (`names` for `px.treemap`) and [parents](https://plotly.com/python/reference/treemap/#treemap-parents) attributes. Click on one sector to zoom in/out, which also displays a pathbar in the upper-left corner of your treemap. To zoom out you can use the path bar as well. ### Basic Treemap with plotly.express @@ -154,10 +154,10 @@ fig.show() This example uses the following attributes: -1. [values](https://plotly.com/python/reference/#treemap-values): sets the values associated with each of the sectors. -2. [textinfo](https://plotly.com/python/reference/#treemap-textinfo): determines which trace information appear on the graph that can be 'text', 'value', 'current path', 'percent root', 'percent entry', and 'percent parent', or any combination of them. -3. [pathbar](https://plotly.com/python/reference/#treemap-pathbar): a main extra feature of treemap to display the current path of the visible portion of the hierarchical map. It may also be useful for zooming out of the graph. -4. [branchvalues](https://plotly.com/python/reference/#treemap-branchvalues): determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. In the example below Eva = 65, which is equal to 14 + 12 + 10 + 2 + 6 + 6 + 1 + 4. +1. [values](https://plotly.com/python/reference/treemap/#treemap-values): sets the values associated with each of the sectors. +2. [textinfo](https://plotly.com/python/reference/treemap/#treemap-textinfo): determines which trace information appear on the graph that can be 'text', 'value', 'current path', 'percent root', 'percent entry', and 'percent parent', or any combination of them. +3. [pathbar](https://plotly.com/python/reference/treemap/#treemap-pathbar): a main extra feature of treemap to display the current path of the visible portion of the hierarchical map. It may also be useful for zooming out of the graph. +4. [branchvalues](https://plotly.com/python/reference/treemap/#treemap-branchvalues): determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. In the example below Eva = 65, which is equal to 14 + 12 + 10 + 2 + 6 + 6 + 1 + 4. When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves. ```python @@ -200,7 +200,7 @@ fig.show() There are three different ways to change the color of the sectors in Treemap: -1. [marker.colors](https://plotly.com/python/reference/#treemap-marker-colors), 2) [colorway](https://plotly.com/python/reference/#treemap-colorway), 3) [colorscale](https://plotly.com/python/reference/#treemap-colorscale). The following examples show how to use each of them. +1. [marker.colors](https://plotly.com/python/reference/treemap/#treemap-marker-colors), 2) [colorway](https://plotly.com/python/reference/treemap/#treemap-colorway), 3) [colorscale](https://plotly.com/python/reference/treemap/#treemap-colorscale). The following examples show how to use each of them. ```python import plotly.graph_objects as go @@ -332,7 +332,7 @@ fig.show() ### Nested Layers in Treemap -The following example uses hierarchical data that includes layers and grouping. Treemap and [Sunburst](https://plotly.com/python/sunburst-charts/) charts reveal insights into the data, and the format of your hierarchical data. [maxdepth](https://plotly.com/python/reference/#treemap-maxdepth) attribute sets the number of rendered sectors from the given level. +The following example uses hierarchical data that includes layers and grouping. Treemap and [Sunburst](https://plotly.com/python/sunburst-charts/) charts reveal insights into the data, and the format of your hierarchical data. [maxdepth](https://plotly.com/python/reference/treemap/#treemap-maxdepth) attribute sets the number of rendered sectors from the given level. ```python import plotly.graph_objects as go @@ -391,4 +391,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#treemap for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/treemap/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/violin.md b/doc/python/violin.md index 6613c5a3c4a..acd179ccb99 100644 --- a/doc/python/violin.md +++ b/doc/python/violin.md @@ -90,7 +90,7 @@ fig.show() ## Violin Plot with go.Violin -If Plotly Express does not provide a good starting point, you can use [the more generic `go.Violin` class from `plotly.graph_objects`](/python/graph-objects/). All the options of `go.Violin` are documented in the reference https://plotly.com/python/reference/#violin +If Plotly Express does not provide a good starting point, you can use [the more generic `go.Violin` class from `plotly.graph_objects`](/python/graph-objects/). All the options of `go.Violin` are documented in the reference https://plotly.com/python/reference/violin/ #### Basic Violin Plot @@ -273,4 +273,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#violin for more information and chart attribute options! +See https://plotly.com/python/reference/violin/ for more information and chart attribute options! diff --git a/doc/python/waterfall-charts.md b/doc/python/waterfall-charts.md index 40a2ddba7ae..27b9a765152 100644 --- a/doc/python/waterfall-charts.md +++ b/doc/python/waterfall-charts.md @@ -57,7 +57,7 @@ fig.show() ``` ### Multi Category Waterfall Chart -This example uses the [waterfallgroupgap attribute](https://plotly.com/python/reference/#layout-waterfallgroupgap), which sets a gap between bars. +This example uses the [waterfallgroupgap attribute](https://plotly.com/python/reference/layout/#layout-waterfallgroupgap), which sets a gap between bars. ```python import plotly.graph_objects as go @@ -88,7 +88,7 @@ fig.show() ``` ### Setting Marker Size and Color -This example uses [decreasing, increasing, and total](https://plotly.com/python/reference/#waterfall-increasing) attributes to customize the bars. +This example uses [decreasing, increasing, and total](https://plotly.com/python/reference/waterfall/#waterfall-increasing) attributes to customize the bars. ```python import plotly.graph_objects as go @@ -129,4 +129,4 @@ fig.show() ``` #### Reference -See https://plotly.com/python/reference/#waterfall for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/waterfall/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/webgl-vs-svg.md b/doc/python/webgl-vs-svg.md index 1b2183bcb7f..af2bc7cbef2 100644 --- a/doc/python/webgl-vs-svg.md +++ b/doc/python/webgl-vs-svg.md @@ -149,4 +149,4 @@ fig.show() ### Reference -See https://plotly.com/python/reference/#scattergl for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/scattergl/ for more information and chart attribute options! \ No newline at end of file diff --git a/doc/python/wind-rose-charts.md b/doc/python/wind-rose-charts.md index bddbac45e9f..17e08fabfdd 100644 --- a/doc/python/wind-rose-charts.md +++ b/doc/python/wind-rose-charts.md @@ -91,4 +91,4 @@ fig.show() #### Reference -See https://plotly.com/python/reference/#barpolar for more information and chart attribute options! \ No newline at end of file +See https://plotly.com/python/reference/barpolar/ for more information and chart attribute options! \ No newline at end of file From c9350e14026c6dad43bae8b9383e627a0c46fa4c Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 23:10:38 +0200 Subject: [PATCH 16/19] print plotly version --- .circleci/config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 08487c83bff..1891eede133 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -406,7 +406,7 @@ jobs: if [ "${CIRCLE_BRANCH}" != "doc-prod" ]; then pip uninstall -y plotly cd ../packages/python/plotly - python3 setup.py install + pip install -e . cd ../../../doc fi echo 'export PATH="/home/circleci/project/doc/node_modules/.bin:$PATH"' >> $BASH_ENV @@ -465,6 +465,7 @@ jobs: cd doc . venv/bin/activate cd apidoc + pip list | grep plotly make html if [ "${CIRCLE_BRANCH}" == "doc-prod" ]; then cd _build/html From 3cb6b315a12dc7db4abca84b49367c486c8c3d0f Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Mon, 3 Aug 2020 23:57:36 +0200 Subject: [PATCH 17/19] clean config files --- .circleci/config.yml | 2 -- doc/apidoc/Makefile | 3 +-- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 1891eede133..8cbb5af72ba 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -465,7 +465,6 @@ jobs: cd doc . venv/bin/activate cd apidoc - pip list | grep plotly make html if [ "${CIRCLE_BRANCH}" == "doc-prod" ]; then cd _build/html @@ -480,7 +479,6 @@ jobs: rm -rf .git cd ../.. fi - tar -zcf _build/api.tgz _build/html cd ../.. - store_artifacts: diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile index f7591037193..06e5fba7bb3 100644 --- a/doc/apidoc/Makefile +++ b/doc/apidoc/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = python3 -m sphinx +SPHINXBUILD = python -m sphinx SOURCEDIR = . BUILDDIR = _build @@ -18,7 +18,6 @@ help: # For sphinx-apidoc the first positional path is the module to document # then all the other ones are paths to exclude for the doc generation %: Makefile - sphinx-build --version sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*.py sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*.py sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*.py From 6c156bfcb600865c9eb3625cebc338fcf1590b85 Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Mon, 3 Aug 2020 18:49:07 -0400 Subject: [PATCH 18/19] fix internal reference links --- doc/python/creating-and-updating-figures.md | 4 ++-- doc/python/figure-structure.md | 6 +++--- doc/python/graph-objects.md | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/python/creating-and-updating-figures.md b/doc/python/creating-and-updating-figures.md index ea149aa95c8..6baab2a55c4 100644 --- a/doc/python/creating-and-updating-figures.md +++ b/doc/python/creating-and-updating-figures.md @@ -68,7 +68,7 @@ The [`plotly.graph_objects` module provides an automatically-generated hierarchy Graph objects have several benefits compared to plain Python dictionaries. 1. Graph objects provide precise data validation. If you provide an invalid property name or an invalid property value as the key to a graph object, an exception will be raised with a helpful error message describing the problem. This is not the case if you use plain Python dictionaries and lists to build your figures. -2. Graph objects contain descriptions of each valid property as Python docstrings, with a [full API reference available](https://plotly.com/python-api-reference/). You can use these docstrings in the development environment of your choice to learn about the available properties as an alternative to consulting the online [Full Reference](/python/reference/). +2. Graph objects contain descriptions of each valid property as Python docstrings, with a [full API reference available](https://plotly.com/python-api-reference/). You can use these docstrings in the development environment of your choice to learn about the available properties as an alternative to consulting the online [Full Reference](/python/reference/index/). 3. Properties of graph objects can be accessed using both dictionary-style key lookup (e.g. `fig["layout"]`) or class-style property access (e.g. `fig.layout`). 4. Graph objects support higher-level convenience functions for making updates to already constructed figures (`.update_layout()`, `.add_trace()` etc) as described below. 5. Graph object constructors and update methods accept "magic underscores" (e.g. `go.Figure(layout_title_text="The Title")` rather than `dict(layout=dict(title=dict(text="The Title")))`) for more compact code, as described below. @@ -652,4 +652,4 @@ fig.data[0].marker.line.width = 4 fig.data[0].marker.line.color = "black" fig.show() -``` \ No newline at end of file +``` diff --git a/doc/python/figure-structure.md b/doc/python/figure-structure.md index 1813c399620..96b5d2affc7 100644 --- a/doc/python/figure-structure.md +++ b/doc/python/figure-structure.md @@ -51,13 +51,13 @@ fig.show() ### Figures as Trees of Attributes -Plotly.js supports inputs adhering to a well-defined schema, whose overall architecture is explained in this page and which is exhaustively documented in the [Figure Reference](/python/reference/) (which is itself generated from a [machine-readable JSON representation of the schema](https://raw.githubusercontent.com/plotly/plotly.js/master/dist/plot-schema.json)). Figures are represented as trees with named nodes called "attributes". The root node of the tree has three top-level attributes: `data`, `layout` and `frames` (see below). +Plotly.js supports inputs adhering to a well-defined schema, whose overall architecture is explained in this page and which is exhaustively documented in the [Figure Reference](/python/reference/index/) (which is itself generated from a [machine-readable JSON representation of the schema](https://raw.githubusercontent.com/plotly/plotly.js/master/dist/plot-schema.json)). Figures are represented as trees with named nodes called "attributes". The root node of the tree has three top-level attributes: `data`, `layout` and `frames` (see below). -Attributes are referred to in text and in the [Figure Reference](/python/reference/) by their full "path" i.e. the dot-delimited concatenation of their parents. For example `"layout.width"` refers to the attribute whose key is `"width"` inside a dict which is the value associated with a key `"layout"` at the root of the figure. If one of the parents is a list rather than a dict, a set of brackets is inserted in the path when referring to the attribute in the abstract, e.g. `"layout.annotations[].text"`. Finally, as explained below, the top-level "data" attribute defines a list of typed objects called "traces" with the schema dependent upon the type, and these attributes' paths are listed in the [Figure Reference](/python/reference/) as `"data[type=scatter].name"`. +Attributes are referred to in text and in the [Figure Reference](/python/reference/index/) by their full "path" i.e. the dot-delimited concatenation of their parents. For example `"layout.width"` refers to the attribute whose key is `"width"` inside a dict which is the value associated with a key `"layout"` at the root of the figure. If one of the parents is a list rather than a dict, a set of brackets is inserted in the path when referring to the attribute in the abstract, e.g. `"layout.annotations[].text"`. Finally, as explained below, the top-level "data" attribute defines a list of typed objects called "traces" with the schema dependent upon the type, and these attributes' paths are listed in the [Figure Reference](/python/reference/index/) as `"data[type=scatter].name"`. The [`plotly.graph_objects` module contains an automatically-generated hierarchy of Python classes](/python/graph-objects/) which represent non-leaf attributes in the figure schema and provide a Pythonic API for them. When [manipulating a `plotly.graph_objects.Figure` object](/python/creating-and-updating-figures/), attributes can be set either directly using Python object attributes e.g. `fig.layout.title.font.family="Open Sans"` or using [update methods and "magic underscores"](/python/creating-and-updating-figures/#magic-underscore-notation) e.g. `fig.update_layout(title_font_family="Open Sans")` -When building a figure, it is *not necessary to populate every attribute* of every object. At render-time, the JavaScript layer will compute default values for each required unspecified attribute, depending upon the ones that are specified, as documented in the [Figure Reference](/python/reference/). An example of this would be `layout.xaxis.range`, which may be specified explicitly, but if not will be computed based on the range of `x` values for every trace linked to that axis. The JavaScript layer will ignore unknown attributes or malformed values, although the `plotly.graph_objects` module provides Python-side validation for attribute values. Note also that if [the `layout.template` key is present (as it is by default)](/python/templates/) then default values will be drawn first from the contents of the template and only if missing from there will the JavaScript layer infer further defaults. The built-in template can be disabled by setting `layout.template="none"`. +When building a figure, it is *not necessary to populate every attribute* of every object. At render-time, the JavaScript layer will compute default values for each required unspecified attribute, depending upon the ones that are specified, as documented in the [Figure Reference](/python/reference/index/). An example of this would be `layout.xaxis.range`, which may be specified explicitly, but if not will be computed based on the range of `x` values for every trace linked to that axis. The JavaScript layer will ignore unknown attributes or malformed values, although the `plotly.graph_objects` module provides Python-side validation for attribute values. Note also that if [the `layout.template` key is present (as it is by default)](/python/templates/) then default values will be drawn first from the contents of the template and only if missing from there will the JavaScript layer infer further defaults. The built-in template can be disabled by setting `layout.template="none"`. ### The Top-Level `data` Attribute diff --git a/doc/python/graph-objects.md b/doc/python/graph-objects.md index 96206c0e6a6..84242256168 100644 --- a/doc/python/graph-objects.md +++ b/doc/python/graph-objects.md @@ -50,7 +50,7 @@ The objects contained in the list which is the [value of the attribute `data` ar Graph objects have several benefits compared to plain Python dictionaries: 1. Graph objects provide precise data validation. If you provide an invalid property name or an invalid property value as the key to a graph object, an exception will be raised with a helpful error message describing the problem. This is not the case if you use plain Python dictionaries and lists to build your figures. -2. Graph objects contain descriptions of each valid property as Python docstrings, with a [full API reference available](https://plotly.com/python-api-reference/). You can use these docstrings in the development environment of your choice to learn about the available properties as an alternative to consulting the online [Full Reference](/python/reference/). +2. Graph objects contain descriptions of each valid property as Python docstrings, with a [full API reference available](https://plotly.com/python-api-reference/). You can use these docstrings in the development environment of your choice to learn about the available properties as an alternative to consulting the online [Full Reference](/python/reference/index/). 3. Properties of graph objects can be accessed using both dictionary-style key lookup (e.g. `fig["layout"]`) or class-style property access (e.g. `fig.layout`). 4. Graph objects support higher-level convenience functions for making updates to already constructed figures (`.update_layout()`, `.add_trace()` etc). 5. Graph object constructors and update methods accept "magic underscores" (e.g. `go.Figure(layout_title_text="The Title")` rather than `dict(layout=dict(title=dict(text="The Title")))`) for more compact code. @@ -88,4 +88,4 @@ fig.update_layout(legend_title_text = "Contestant") fig.update_xaxes(title_text="Fruit") fig.update_yaxes(title_text="Number Eaten") fig.show() -``` \ No newline at end of file +``` From cfc578c67aa32382999a796889ff2ece7b84a538 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 4 Aug 2020 15:56:54 +0200 Subject: [PATCH 19/19] use local plotly also in doc-prod --- .circleci/config.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 8cbb5af72ba..4423d5eeabb 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -464,6 +464,15 @@ jobs: command: | cd doc . venv/bin/activate + # For the API doc, we need to use the local version of plotly + # since we are tweaking the source because of + # graph_objs/graph_objects + if [ "${CIRCLE_BRANCH}" == "doc-prod" ]; then + pip uninstall -y plotly + cd ../packages/python/plotly + pip install -e . + cd ../../../doc + fi cd apidoc make html if [ "${CIRCLE_BRANCH}" == "doc-prod" ]; then