Update docs to 0.12.1

matplotlib · Jan 19, 2024 · 8035a91 · 8035a91
1 parent 20d3d3c
commit 8035a91
Show file tree

Hide file tree

Showing 50 changed files with 1,455 additions and 14,112 deletions.
diff --git a/.buildinfo b/.buildinfo
diff --git a/index-4.py → ...86cd1ad3f1e8c1ad7ce523861a47e0/index-4.py b/index-4.py → ...86cd1ad3f1e8c1ad7ce523861a47e0/index-4.py
diff --git a/index-3.hires.png → ...f54b5e1007e51e5d2b4e975/index-3.hires.png b/index-3.hires.png → ...f54b5e1007e51e5d2b4e975/index-3.hires.png
diff --git a/_downloads/145ac4d4fe50481dc12bead0aab95437/index-3.pdf b/_downloads/145ac4d4fe50481dc12bead0aab95437/index-3.pdf
diff --git a/_downloads/5710ee0df8b867f7b6d08f84831931d7/index-2.pdf b/_downloads/5710ee0df8b867f7b6d08f84831931d7/index-2.pdf
diff --git a/index-1.png → ...ff23a880d1b8b7456f0ead4b9ed3c/index-1.png b/index-1.png → ...ff23a880d1b8b7456f0ead4b9ed3c/index-1.png
diff --git a/_downloads/605d27919a37b6f4b739afd44a433043/index-4.pdf b/_downloads/605d27919a37b6f4b739afd44a433043/index-4.pdf
diff --git a/index-4.hires.png → ...da359d2e4252c17ed713218/index-4.hires.png b/index-4.hires.png → ...da359d2e4252c17ed713218/index-4.hires.png
diff --git a/index-3.py → ...58fe54000965f7cad6f68eda5dea5d/index-3.py b/index-3.py → ...58fe54000965f7cad6f68eda5dea5d/index-3.py
diff --git a/index-1.hires.png → ...dfb94acf98d26135927bfc9/index-1.hires.png b/index-1.hires.png → ...dfb94acf98d26135927bfc9/index-1.hires.png
diff --git a/index-4.png → ...56b7cadd63dbc5972f4d3a604110d/index-4.png b/index-4.png → ...56b7cadd63dbc5972f4d3a604110d/index-4.png
diff --git a/_downloads/c72cdcb2d8a2165c77e365185fcea378/index-1.pdf b/_downloads/c72cdcb2d8a2165c77e365185fcea378/index-1.pdf
diff --git a/index-1.py → ...4f939e75d32f21d99c47dd42caa575/index-1.py b/index-1.py → ...4f939e75d32f21d99c47dd42caa575/index-1.py
diff --git a/_downloads/cf08f36bd983131e24621c94288ea0d9/index-2.hires.png b/_downloads/cf08f36bd983131e24621c94288ea0d9/index-2.hires.png
diff --git a/_downloads/da097dda36ad3abf55fcd67455286f1b/index-2.png b/_downloads/da097dda36ad3abf55fcd67455286f1b/index-2.png
diff --git a/index-2.py → ...bf5b406a6762b380a0f13f3f68eee3/index-2.py b/index-2.py → ...bf5b406a6762b380a0f13f3f68eee3/index-2.py
diff --git a/index-3.png → ...ee615d2d3b6683fb182d98a22b0ae/index-3.png b/index-3.png → ...ee615d2d3b6683fb182d98a22b0ae/index-3.png
diff --git a/_images/index-1.png b/_images/index-1.png
diff --git a/_images/index-2.png b/_images/index-2.png
diff --git a/_images/index-3.png b/_images/index-3.png
diff --git a/_images/index-4.png b/_images/index-4.png
diff --git a/_modules/cycler.html b/_modules/cycler.html
diff --git a/_modules/index.html b/_modules/index.html
@@ -1,25 +1,24 @@
-
 <!DOCTYPE html>
 
-<html>
+<html lang="en" data-content_root="../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; cycler 0.11.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
+    <title>Overview: module code &#8212; cycler 0.12.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=12dfc556" />
     <link rel="stylesheet" type="text/css" href="../_static/plot_directive.css" />
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/jquery.js"></script>
-    <script src="../_static/underscore.js"></script>
-    <script src="../_static/doctools.js"></script>
+    <script src="../_static/documentation_options.js?v=c5b435e8"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
 
   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
 
+
+
 
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head><body>
 
@@ -41,6 +40,29 @@ <h1>All modules for which code is available</h1>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">cycler</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../generated/cycler.cycler.html">cycler.cycler</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../generated/cycler.Cycler.html">cycler.Cycler</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../generated/cycler.concat.html">cycler.concat</a></li>
+</ul>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
 <div id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
@@ -50,17 +72,25 @@ <h3 id="searchlabel">Quick search</h3>
     </form>
     </div>
 </div>
-<script>$('#searchbox').show(0);</script>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
         </div>
       </div>
       <div class="clearer"></div>
     </div>
     <div class="footer">
-      &copy;2015, Matplotlib Developers.
+      &#169;2015, Matplotlib Developers.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
 
     </div>
 

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -40,10 +40,10 @@ composition and iteration logic.
 Base
 ----
 
-A single entry `Cycler` object can be used to easily
-cycle over a single style.  To create the `Cycler` use the :py:func:`cycler`
-function to link a key/style/kwarg to series of values.  The key must be
-hashable (as it will eventually be used as the key in a :obj:`dict`).
+A single entry `Cycler` object can be used to easily cycle over a single style.
+To create the `Cycler` use the :py:func:`cycler` function to link a
+key/style/keyword argument to series of values. The key must be hashable (as it
+will eventually be used as the key in a :obj:`dict`).
 
 .. ipython:: python
 
@@ -53,7 +53,7 @@ hashable (as it will eventually be used as the key in a :obj:`dict`).
    color_cycle = cycler(color=['r', 'g', 'b'])
    color_cycle
 
-The `Cycler` knows it's length and keys:
+The `Cycler` knows its length and keys:
 
 .. ipython:: python
 
@@ -97,7 +97,7 @@ create complex multi-key cycles.
 Addition
 ~~~~~~~~
 
-Equal length `Cycler` s with different keys can be added to get the
+Equal length `Cycler`\s with different keys can be added to get the
 'inner' product of two cycles
 
 .. ipython:: python
@@ -180,7 +180,7 @@ matrices)
 Integer Multiplication
 ~~~~~~~~~~~~~~~~~~~~~~
 
-`Cycler` s can also be multiplied by integer values to increase the length.
+`Cycler`\s can also be multiplied by integer values to increase the length.
 
 .. ipython:: python
 
@@ -331,8 +331,7 @@ the same style.
 Exceptions
 ----------
 
-
-A :obj:`ValueError` is raised if unequal length `Cycler` s are added together
+A :obj:`ValueError` is raised if unequal length `Cycler`\s are added together
 
 .. ipython:: python
    :okexcept:
@@ -401,6 +400,6 @@ However, if you want to do something more complicated:
 
    ax.legend(loc=0)
 
-the plotting logic can quickly become very involved.  To address this and allow easy
-cycling over arbitrary ``kwargs`` the `Cycler` class, a composable
-kwarg iterator, was developed.
+the plotting logic can quickly become very involved.  To address this and allow
+easy cycling over arbitrary ``kwargs`` the `Cycler` class, a composable keyword
+argument iterator, was developed.
diff --git a/_static/alabaster.css b/_static/alabaster.css
@@ -69,6 +69,11 @@ div.relations {
 }
 
 
+div.sphinxsidebar {
+    max-height: 100%;
+    overflow-y: auto;
+}
+
 div.sphinxsidebar a {
     color: #444;
     text-decoration: none;
@@ -155,6 +160,14 @@ div.sphinxsidebar input {
     font-size: 1em;
 }
 
+div.sphinxsidebar #searchbox input[type="text"] {
+    width: 160px;
+}
+
+div.sphinxsidebar .search > div {
+    display: table-cell;
+}
+
 div.sphinxsidebar hr {
     border: none;
     height: 1px;
@@ -419,7 +432,9 @@ table.footnote td {
 }
 
 dl {
-    margin: 0;
+    margin-left: 0;
+    margin-right: 0;
+    margin-top: 0;
     padding: 0;
 }
 
@@ -636,15 +651,7 @@ a:hover tt, a:hover code {
     display: none!important;
 }
 
-/* Make nested-list/multi-paragraph items look better in Releases changelog
- * pages. Without this, docutils' magical list fuckery causes inconsistent
- * formatting between different release sub-lists.
- */
-div#changelog > div.section > ul > li > p:only-child {
-    margin-bottom: 0;
-}
-
-/* Hide fugly table cell borders in ..bibliography:: directive output */
+/* Hide ugly table cell borders in ..bibliography:: directive output */
 table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
   border: none;
   /* Below needed in some edge cases; if not applied, bottom shadows appear */

diff --git a/_static/basic.css b/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -222,7 +222,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: 450px;
+    min-width: inherit;
     max-width: 800px;
 }
 
@@ -237,14 +237,8 @@ a.headerlink {
     visibility: hidden;
 }
 
-a.brackets:before,
-span.brackets > a:before{
-    content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
-    content: "]";
+a:visited {
+    color: #551A8B;
 }
 
 h1:hover > a.headerlink,
@@ -335,12 +329,16 @@ p.sidebar-title {
     font-weight: bold;
 }
 
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
     clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
 
+nav.contents,
+aside.topic,
 div.topic {
     border: 1px solid #ccc;
     padding: 7px;
@@ -379,13 +377,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -428,10 +430,6 @@ table.docutils td, table.docutils th {
     border-bottom: 1px solid #aaa;
 }
 
-table.footnote td, table.footnote th {
-    border: 0 !important;
-}
-
 th {
     text-align: left;
     padding-right: 5px;
@@ -615,19 +613,26 @@ ul.simple p {
     margin-bottom: 0;
 }
 
-dl.footnote > dt,
-dl.citation > dt {
+aside.footnote > span,
+div.citation > span {
     float: left;
-    margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+  padding-right: 0.5em;
+}
+aside.footnote > p {
+  margin-left: 2em;
+}
+div.citation > p {
+  margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
     margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
     content: "";
     clear: both;
 }
@@ -644,10 +649,6 @@ dl.field-list > dt {
     padding-right: 5px;
 }
 
-dl.field-list > dt:after {
-    content: ":";
-}
-
 dl.field-list > dd {
     padding-left: 0.5em;
     margin-top: 0em;
@@ -673,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -731,15 +742,24 @@ dl.glossary dt {
 
 .classifier:before {
     font-style: normal;
-    margin: 0.5em;
+    margin: 0 0.5em;
     content: ":";
+    display: inline-block;
 }
 
 abbr, acronym {
     border-bottom: dotted 1px;
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {
@@ -756,6 +776,7 @@ span.pre {
     -ms-hyphens: none;
     -webkit-hyphens: none;
     hyphens: none;
+    white-space: nowrap;
 }
 
 div[class*="highlight-"] {