Skip to content
This repository was archived by the owner on Jun 3, 2024. It is now read-only.

Commit 5955868

Browse files
docs regen
1 parent 16a55ff commit 5955868

File tree

6 files changed

+734
-684
lines changed

6 files changed

+734
-684
lines changed

docs/plotly_express/colors/diverging.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h1 class="title"><code>plotly_express.colors.diverging</code></h1>
3030
</header>
3131
<section id="section-intro">
3232
<p>Diverging color scales are appropriate for continuous data that has a natural midpoint other otherwise informative special value, such as 0 altitude, or the boiling point
33-
of a liquid.</p>
33+
of a liquid. The color scales in this module are mostly meant to be passed in as the <code>color_continuous_scale</code> argument to various functions, and to be used with the <code>color_continuous_midpoint</code> argument.</p>
3434
</section>
3535
<section>
3636
</section>

docs/plotly_express/colors/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
5656
</dd>
5757
<dt><code class="name"><a title="plotly_express.colors.qualitative" href="qualitative.html">plotly_express.colors.qualitative</a></code></dt>
5858
<dd>
59-
<section class="desc"><p>Qualitative color sequences are appropriate for data that has no natural ordering, such as categories, colors, names, countries etc.</p></section>
59+
<section class="desc"><p>Qualitative color sequences are appropriate for data that has no natural ordering, such as categories, colors, names, countries etc. The color …</p></section>
6060
</dd>
6161
<dt><code class="name"><a title="plotly_express.colors.sequential" href="sequential.html">plotly_express.colors.sequential</a></code></dt>
6262
<dd>

docs/plotly_express/colors/qualitative.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
gtag('config', 'UA-39373211-1');
1414
</script>
1515
<title>plotly_express.colors.qualitative API documentation</title>
16-
<meta name="description" content="Qualitative color sequences are appropriate for data that has no natural ordering, such as categories, colors, names, countries etc." />
16+
<meta name="description" content="Qualitative color sequences are appropriate for data that has no natural ordering, such as categories, colors, names, countries etc. The color …" />
1717
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
1818
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
1919
<link href="https://fonts.googleapis.com/css?family=Dosis:500|Inconsolata|Open+Sans" rel="stylesheet">
@@ -29,7 +29,7 @@
2929
<h1 class="title"><code>plotly_express.colors.qualitative</code></h1>
3030
</header>
3131
<section id="section-intro">
32-
<p>Qualitative color sequences are appropriate for data that has no natural ordering, such as categories, colors, names, countries etc.</p>
32+
<p>Qualitative color sequences are appropriate for data that has no natural ordering, such as categories, colors, names, countries etc. The color sequences in this module are mostly meant to be passed in as the <code>color_discrete_sequence</code> argument to various functions.</p>
3333
</section>
3434
<section>
3535
</section>

docs/plotly_express/colors/sequential.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<h1 class="title"><code>plotly_express.colors.sequential</code></h1>
3030
</header>
3131
<section id="section-intro">
32-
<p>Sequential color scales are appropriate for most continuous data, but in some cases it can be helpful to use a <a title="plotly_express.colors.diverging" href="diverging.html"><code>plotly_express.colors.diverging</code></a> or <a title="plotly_express.colors.cyclical" href="cyclical.html"><code>plotly_express.colors.cyclical</code></a> scale instead.</p>
32+
<p>Sequential color scales are appropriate for most continuous data, but in some cases it can be helpful to use a <a title="plotly_express.colors.diverging" href="diverging.html"><code>plotly_express.colors.diverging</code></a> or <a title="plotly_express.colors.cyclical" href="cyclical.html"><code>plotly_express.colors.cyclical</code></a> scale instead. The color scales in this module are mostly meant to be passed in as the <code>color_continuous_scale</code> argument to various functions.</p>
3333
</section>
3434
<section>
3535
</section>

docs/plotly_express/data/index.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
4545
<section class="desc"><p>Each row represents a country on a given year.</p>
4646
<p><a href="https://www.gapminder.org/data/">https://www.gapminder.org/data/</a></p>
4747
<h2 id="returns">Returns</h2>
48-
<p>A <code>pandas.DataFrame</code> with 1704 rows and columns <code>['country', 'continent', 'year', 'lifeExp', 'pop', 'gdpPercap',
48+
<p>A <code>pandas.DataFrame</code> with 1704 rows and the following columns: <code>['country', 'continent', 'year', 'lifeExp', 'pop', 'gdpPercap',
4949
'iso_alpha', 'iso_num']</code>.</p></section>
5050
</dd>
5151
<dt id="plotly_express.data.tips"><code class="name flex">
@@ -55,7 +55,7 @@ <h2 id="returns">Returns</h2>
5555
<section class="desc"><p>Each row represents a restaurant bill.</p>
5656
<p><a href="https://vincentarelbundock.github.io/Rdatasets/doc/reshape2/tips.html">https://vincentarelbundock.github.io/Rdatasets/doc/reshape2/tips.html</a></p>
5757
<h2 id="returns">Returns</h2>
58-
<p>A <code>pandas.DataFrame</code> with 244 rows and columns <code>['total_bill', 'tip', 'sex', 'smoker', 'day', 'time', 'size']</code>.</p></section>
58+
<p>A <code>pandas.DataFrame</code> with 244 rows and the following columns: <code>['total_bill', 'tip', 'sex', 'smoker', 'day', 'time', 'size']</code>.</p></section>
5959
</dd>
6060
<dt id="plotly_express.data.iris"><code class="name flex">
6161
<span>def <span class="ident">iris</span></span>(<span>)</span>
@@ -64,7 +64,7 @@ <h2 id="returns">Returns</h2>
6464
<section class="desc"><p>Each row represents a flower.</p>
6565
<p><a href="https://en.wikipedia.org/wiki/Iris_flower_data_set">https://en.wikipedia.org/wiki/Iris_flower_data_set</a></p>
6666
<h2 id="returns">Returns</h2>
67-
<p>A <code>pandas.DataFrame</code> with 150 rows and columns <code>['sepal_length', 'sepal_width', 'petal_length', 'petal_width', 'species',
67+
<p>A <code>pandas.DataFrame</code> with 150 rows and the following columns: <code>['sepal_length', 'sepal_width', 'petal_length', 'petal_width', 'species',
6868
'species_id']</code>.</p></section>
6969
</dd>
7070
<dt id="plotly_express.data.wind"><code class="name flex">
@@ -73,23 +73,23 @@ <h2 id="returns">Returns</h2>
7373
<dd>
7474
<section class="desc"><p>Each row represents a level of wind intensity in a cardinal direction.</p>
7575
<h2 id="returns">Returns</h2>
76-
<p>A <code>pandas.DataFrame</code> with 128 rows and columns <code>['direction', 'strength', 'value']</code>.</p></section>
76+
<p>A <code>pandas.DataFrame</code> with 128 rows and the following columns: <code>['direction', 'strength', 'value']</code>.</p></section>
7777
</dd>
7878
<dt id="plotly_express.data.election"><code class="name flex">
7979
<span>def <span class="ident">election</span></span>(<span>)</span>
8080
</code></dt>
8181
<dd>
8282
<section class="desc"><p>Each row represents voting results for an electoral district in the 2013 Montreal mayoral election.</p>
8383
<h2 id="returns">Returns</h2>
84-
<p>A <code>pandas.DataFrame</code> with 58 rows and columns <code>['district', 'Coderre', 'Bergeron', 'Joly', 'total', 'winner', 'result']</code>.</p></section>
84+
<p>A <code>pandas.DataFrame</code> with 58 rows and the following columns: <code>['district', 'Coderre', 'Bergeron', 'Joly', 'total', 'winner', 'result']</code>.</p></section>
8585
</dd>
8686
<dt id="plotly_express.data.carshare"><code class="name flex">
8787
<span>def <span class="ident">carshare</span></span>(<span>)</span>
8888
</code></dt>
8989
<dd>
9090
<section class="desc"><p>Each row represents the availability of car-sharing services near the centroid of a zone in Montreal.</p>
9191
<h2 id="returns">Returns</h2>
92-
<p>A <code>pandas.DataFrame</code> with 249 rows and columns <code>['centroid_lat', 'centroid_lon', 'car_hours', 'peak_hour']</code>.</p></section>
92+
<p>A <code>pandas.DataFrame</code> with 249 rows and the following columns: <code>['centroid_lat', 'centroid_lon', 'car_hours', 'peak_hour']</code>.</p></section>
9393
</dd>
9494
</dl>
9595
</section>

0 commit comments

Comments
 (0)