Skip to content

Commit

Permalink
Deploying to gh-pages from @ sympy/sympy@430a730 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarbenjamin committed Jan 7, 2025
1 parent 9a45f8e commit 1759c11
Show file tree
Hide file tree
Showing 446 changed files with 13,652 additions and 13,652 deletions.
Binary file modified dev/_downloads/0130acc9674ca6615e762dac32f6f525/matrices-10.pdf
Binary file not shown.
Binary file modified dev/_downloads/0249fb66c2fcb06b78bd6a84135be88a/beam-2.pdf
Binary file not shown.
Binary file modified dev/_downloads/02f5470280a542a7c80635a082cb7e09/beam-23.pdf
Binary file not shown.
Binary file modified dev/_downloads/034c3ce6c53eca7932c83f9b35d14c64/plotting-2.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/0a5b397c3adc07987864b0441654dc1c/beam-1.pdf
Binary file not shown.
Binary file modified dev/_downloads/0c7c1262b6b611b1944eed12f33413fe/beam-5.pdf
Binary file not shown.
Binary file modified dev/_downloads/0eb265c8614c7bd3f16f6034d076f6d3/beam-21.pdf
Binary file not shown.
Binary file modified dev/_downloads/0efc8f797e345bcc903c8f4dab4a5322/plotting-4.pdf
Binary file not shown.
Binary file modified dev/_downloads/0ffd2a0f4570e502b64ad8529258801f/plotting-17.pdf
Binary file not shown.
Binary file modified dev/_downloads/1362531cda049d5b7f4db4abe11d4178/plotting-6.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/16c046e4f150f3aca5fb6bd438b952ce/matrices-24.pdf
Binary file not shown.
Binary file modified dev/_downloads/16f8dba9abaa041f16c4636d6e41a0ac/matrices-25.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/1f24a27fa4a24f0b331e9442f61363d7/plotting-16.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified dev/_downloads/2454d35ad3fc284cb67b6c619b4246c1/beam-8.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/2608cc95ac952e335ca0ce8cea458c1b/matrices-22.pdf
Binary file not shown.
Binary file modified dev/_downloads/2667a5fcc739d282a7512f6b7b39071a/matrices-4.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/2acde0fab574588f4a28670019a75bf9/plotting-26.pdf
Binary file not shown.
Binary file modified dev/_downloads/2f44ee19ebd4c314ad1c408629357c53/plotting-1.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/39dc203c3bf6e7485368c7a401448a6f/matrices-8.pdf
Binary file not shown.
Binary file modified dev/_downloads/3af3ee18448b7a687ef6594665f932f9/plotting-19.pdf
Binary file not shown.
Binary file modified dev/_downloads/3cd14c510b41514f1496a3155ea8cf2d/matrices-17.pdf
Binary file not shown.
Binary file modified dev/_downloads/464f047ba3ef7f04429a4eb163a6a2de/matrices-18.pdf
Binary file not shown.
Binary file modified dev/_downloads/4c9cbd846f69df68795ea4e2cdf667e9/plotting-33.pdf
Binary file not shown.
Binary file modified dev/_downloads/4d0c9c96647fc2441757598f44d4936b/beam-20.pdf
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/56447441b8d8108229134a5d3454516c/plotting-7.pdf
Binary file not shown.
Binary file modified dev/_downloads/569497501b2d3eb864ce466d19b06017/plotting-20.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/5815ed289d6d66d90e420fd31330fef7/plotting-28.pdf
Binary file not shown.
Binary file modified dev/_downloads/5860560b08ead850923e530e3240b5c6/plotting-15.pdf
Binary file not shown.
Binary file modified dev/_downloads/5b83bd080155a6f59e2eeb633bda5ab4/matrices-13.pdf
Binary file not shown.
Binary file modified dev/_downloads/6236456dc31640e622c3f943842d9925/plotting-27.pdf
Binary file not shown.
Binary file modified dev/_downloads/68597f1bcbf2528fdc041a5c14e53f0f/plotting-30.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified dev/_downloads/704bfe351153d402a4a0a831ece25675/matrices-2.pdf
Binary file not shown.
Binary file modified dev/_downloads/76c597139b65debdf0e125c15cd040ca/plotting-25.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/78092bdffcba955dd374da738fd5c1d2/control_plots-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/7bfa6a992ea402720a120fd5093741a4/plotting-11.pdf
Binary file not shown.
Binary file modified dev/_downloads/7d4a2d083d96719b05ab2f759c57874a/matrices-6.pdf
Binary file not shown.
Binary file modified dev/_downloads/7eed1bf07a4dacbb97d209dac2614e9a/matrices-19.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/81a43cb7598cbbe880e19146241abe5f/plotting-26.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/81a780d815116a5eb737d2d484c44444/matrices-21.pdf
Binary file not shown.
Binary file modified dev/_downloads/81f16477713a2ebedd53f1c8ec85b754/plotting-12.pdf
Binary file not shown.
Binary file modified dev/_downloads/83ec70596dcaacc88e256e7679fafcee/matrices-12.pdf
Binary file not shown.
Binary file modified dev/_downloads/865dedeca3d1430244910d89d552e5ef/beam-19.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/8c3e8789c867600d80b2cce11272d81e/matrices-15.pdf
Binary file not shown.
Binary file modified dev/_downloads/8f6a7c938e347f134c67566d5aef740d/plotting-29.pdf
Binary file not shown.
Binary file modified dev/_downloads/90b2354acc779cd49f552b57929e55ab/plotting-13.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/950e4c42a3beff8bac74d47e0f8d8516/plotting-24.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/95feb1999af91b22f624aa3ce3c6b1c4/solve-ode-1.pdf
Binary file not shown.
Binary file modified dev/_downloads/9659cd876877dfc4002fae48de3c98ae/beam-4.pdf
Binary file not shown.
Binary file modified dev/_downloads/9728219edea47500a9403b3679a5bc09/plotting-10.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/9ba0a373644e3b8e75cb2f2d1a46ac33/plotting-35.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/a11367bb58b03bf09a75c9657b4e223a/matrices-16.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/a3a06dbcaf4cb9dbce7fe53c37ec22a8/plotting-30.pdf
Binary file not shown.
Binary file modified dev/_downloads/a45cb86364a3602f7138b4466beb1097/beam-3.pdf
Binary file not shown.
Binary file modified dev/_downloads/a6ba697f4fd41244d4a03ae13c871d77/matrices-20.pdf
Binary file not shown.
Binary file modified dev/_downloads/a892d8f10080acfce9914123b164dd0e/matrices-11.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/ac472fec5b32a66f329e9328277c64b3/plotting-34.pdf
Binary file not shown.
Binary file modified dev/_downloads/b0f2a5ef738f9e96458a670bdb264732/beam-18.pdf
Binary file not shown.
Binary file modified dev/_downloads/b78b32e3870f0d0ffa753084ae625ec7/plotting-9.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/c1adee8d5f4e9aedd715240ee2abc6e5/matrices-9.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/ca52fc8f0db47908fb8d38cc335d5c1a/plotting-22.pdf
Binary file not shown.
Binary file modified dev/_downloads/cb44a32b25833934efb3a9d4adfe400c/plotting-29.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/cbc065b1401edd3c94be5ede9811b881/plotting-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/cc4619d4e67ea48ddf5026828b7569eb/beam-22.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/d1eadb36634e8e0276f3d1752e83893e/matrices-14.pdf
Binary file not shown.
Binary file modified dev/_downloads/d2c03725fdbe7104e13f46e3798a03e1/beam-7.pdf
Binary file not shown.
Binary file modified dev/_downloads/d3453595eb36f834c2ad86d18546535c/matrices-7.pdf
Binary file not shown.
Binary file modified dev/_downloads/d4935c2256660a8a33a7af58457af366/beam-6.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/dac00acb10450bde21ecfc4fd9c34817/matrices-1.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/ddddc4679201fda850a702ce6ca7ff1e/plotting-5.pdf
Binary file not shown.
Binary file modified dev/_downloads/e0563f4c3c89c72192ce76efd2e6fe6b/matrices-3.pdf
Binary file not shown.
Binary file modified dev/_downloads/e07f3720dbc2048eb106de8a904dcfa9/plotting-25.pdf
Binary file not shown.
Binary file modified dev/_downloads/e51f495094ca971c2da007d95d7c6aff/matrices-5.pdf
Binary file not shown.
Binary file modified dev/_downloads/e8a5010f49b1076156ddfe2fa5fe6189/beam-9.pdf
Binary file not shown.
Binary file modified dev/_downloads/eb990a3106294a2a2f898aea0b429ab7/matrices-23.pdf
Binary file not shown.
Binary file modified dev/_downloads/ebf272f79479d63cc5b71ad0f0e41f7d/fourier-1.pdf
Binary file not shown.
Binary file modified dev/_downloads/ee22a6375b132bbe50ac86a0282c8f8f/fourier-2.pdf
Binary file not shown.
Binary file modified dev/_downloads/eeb0510df619706f09011b7e73e32d5e/plotting-37.pdf
Binary file not shown.
Binary file modified dev/_downloads/ef1b602db6b31a5b8d8b9d20a2410f41/beam-10.pdf
Binary file not shown.
Binary file modified dev/_downloads/f0b1ed1309beacf065f53d41a069ebe1/plotting-24.pdf
Binary file not shown.
Binary file not shown.
Binary file modified dev/_downloads/f143e8af7f67232f463360136b513860/truss-1.pdf
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_downloads/fd56e7819f0c6e7eb6ed1e026733b894/plotting-36.pdf
Binary file not shown.
Binary file modified dev/_downloads/fd7d64e97562f1e8bfd34628ef58f000/plotting-31_01.pdf
Binary file not shown.
Binary file modified dev/_downloads/fd8f37f13aecb42027ed8c23548b8132/plotting-31_00.pdf
Binary file not shown.
Binary file modified dev/_images/control_plots-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/plotting-24.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/plotting-25.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/plotting-26.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/plotting-29.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/plotting-30.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified dev/_images/plotting-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
382 changes: 191 additions & 191 deletions dev/_static/pygments.css

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/citing.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<link rel="shortcut icon" href="_static/sympy-notailtext-favicon.ico"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Citing SymPy - SymPy 1.14.dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=16cf08d2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=6ad9bad0" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
Expand Down Expand Up @@ -878,7 +878,7 @@ <h1>Citing SymPy<a class="headerlink" href="#citing-sympy" title="Link to this h

<a href="https://github.com/pradyunsg/furo">Furo</a>
<div class="last-updated">
Last updated on Jan 05, 2025</div>
Last updated on Jan 07, 2025</div>
</div>
<div class="right-details">
<div class="icons">
Expand Down
4 changes: 2 additions & 2 deletions dev/contributing/debug.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<link rel="shortcut icon" href="../_static/sympy-notailtext-favicon.ico"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Debugging - SymPy 1.14.dev documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=16cf08d2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6ad9bad0" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
Expand Down Expand Up @@ -850,7 +850,7 @@ <h1>Debugging<a class="headerlink" href="#debugging" title="Link to this heading

<a href="https://github.com/pradyunsg/furo">Furo</a>
<div class="last-updated">
Last updated on Jan 05, 2025</div>
Last updated on Jan 07, 2025</div>
</div>
<div class="right-details">
<div class="icons">
Expand Down
6 changes: 3 additions & 3 deletions dev/contributing/dependencies.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<link rel="shortcut icon" href="../_static/sympy-notailtext-favicon.ico"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Dependencies - SymPy 1.14.dev documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=16cf08d2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6ad9bad0" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
Expand Down Expand Up @@ -1103,7 +1103,7 @@ <h3>Optional SymEngine Backend<a class="headerlink" href="#optional-symengine-ba
<a class="reference internal" href="../modules/liealgebras/index.html#lie-algebras"><span class="std std-ref">sympy.liealgebras</span></a> modules, although you can also interface
with SymPy’s SymEngine backend directly by importing things from
<code class="docutils literal notranslate"><span class="pre">sympy.core.backend</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">sympy.core.backend</span> <span class="kn">import</span> <span class="n">Symbol</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">sympy.core.backend</span><span class="w"> </span><span class="kn">import</span> <span class="n">Symbol</span>
<span class="gp">&gt;&gt;&gt; </span><span class="c1"># This will create a SymEngine Symbol object if the USE_SYMENGINE</span>
<span class="gp">&gt;&gt;&gt; </span><span class="c1"># environment variable is configured. Otherwise it will be an ordinary</span>
<span class="gp">&gt;&gt;&gt; </span><span class="c1"># SymPy Symbol object.</span>
Expand Down Expand Up @@ -1228,7 +1228,7 @@ <h3>Running the Benchmarks<a class="headerlink" href="#running-the-benchmarks" t

<a href="https://github.com/pradyunsg/furo">Furo</a>
<div class="last-updated">
Last updated on Jan 05, 2025</div>
Last updated on Jan 07, 2025</div>
</div>
<div class="right-details">
<div class="icons">
Expand Down
10 changes: 5 additions & 5 deletions dev/contributing/deprecations.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<link rel="shortcut icon" href="../_static/sympy-notailtext-favicon.ico"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Deprecation Policy - SymPy 1.14.dev documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=16cf08d2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6ad9bad0" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
Expand Down Expand Up @@ -1069,7 +1069,7 @@ <h3>Adding the deprecation to the code<a class="headerlink" href="#adding-the-de
<a class="reference internal" href="#deprecation-documentation"><span class="std std-ref">below</span></a> for an example.</p>
<p>Add a test for the deprecated behavior. Use the
<a class="reference internal" href="../modules/testing/pytest.html#sympy.testing.pytest.warns_deprecated_sympy" title="sympy.testing.pytest.warns_deprecated_sympy"><code class="xref py py-func docutils literal notranslate"><span class="pre">sympy.testing.pytest.warns_deprecated_sympy()</span></code></a> context manager.</p>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">sympy.testing.pytest</span> <span class="kn">import</span> <span class="n">warns_deprecated_sympy</span>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">sympy.testing.pytest</span><span class="w"> </span><span class="kn">import</span> <span class="n">warns_deprecated_sympy</span>

<span class="k">with</span> <span class="n">warns_deprecated_sympy</span><span class="p">():</span>
<span class="o">&lt;</span><span class="n">deprecated</span> <span class="n">behavior</span><span class="o">&gt;</span>
Expand Down Expand Up @@ -1158,7 +1158,7 @@ <h3>Adding the deprecation to the code<a class="headerlink" href="#adding-the-de
<span class="s2">The simplify_this(expr) function is deprecated. Use simplify(expr)</span>
<span class="s2">instead.&quot;&quot;&quot;</span><span class="p">,</span> <span class="n">deprecated_since_version</span><span class="o">=</span><span class="s2">&quot;1.1&quot;</span><span class="p">,</span>
<span class="n">active_deprecations_target</span><span class="o">=</span><span class="s1">&#39;simplify-this-deprecation&#39;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">simplify_this</span><span class="p">(</span><span class="n">expr</span><span class="p">):</span>
<span class="k">def</span><span class="w"> </span><span class="nf">simplify_this</span><span class="p">(</span><span class="n">expr</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Simplify ``expr``.</span>

Expand All @@ -1172,7 +1172,7 @@ <h3>Adding the deprecation to the code<a class="headerlink" href="#adding-the-de
<span class="k">return</span> <span class="n">simplify</span><span class="p">(</span><span class="n">expr</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">is_this_zero</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">is_this_zero</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Determine if x = 0.</span>

Expand Down Expand Up @@ -1319,7 +1319,7 @@ <h3>Release notes entry<a class="headerlink" href="#release-notes-entry" title="

<a href="https://github.com/pradyunsg/furo">Furo</a>
<div class="last-updated">
Last updated on Jan 05, 2025</div>
Last updated on Jan 07, 2025</div>
</div>
<div class="right-details">
<div class="icons">
Expand Down
20 changes: 10 additions & 10 deletions dev/contributing/docstring.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<link rel="shortcut icon" href="../_static/sympy-notailtext-favicon.ico"/><!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<title>Docstrings Style Guide - SymPy 1.14.dev documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=16cf08d2" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6ad9bad0" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
Expand Down Expand Up @@ -811,7 +811,7 @@ <h2>General Guidelines<a class="headerlink" href="#general-guidelines" title="Li
becomes the <code class="docutils literal notranslate"><span class="pre">__doc__</span></code> special attribute of that object.</p>
<p><strong>Example</strong></p>
<p>Here is a basic docstring:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">fdiff</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">argindex</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">fdiff</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">argindex</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Returns the first derivative of a Heaviside Function.</span>

Expand Down Expand Up @@ -990,7 +990,7 @@ <h3>2. Explanation Section<a class="headerlink" href="#explanation-section" titl
<p>You should only skip the testing of an example if it is impossible to test it.
If necessary, testing of an example can be skipped by adding a special comment.</p>
<p><strong>Example</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">random</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span><span class="w"> </span><span class="nn">random</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">()</span>
<span class="go">0.6868680200532414</span>
</pre></div>
Expand All @@ -1000,8 +1000,8 @@ <h3>2. Explanation Section<a class="headerlink" href="#explanation-section" titl
continuation as in a Python prompt. For example, from the ODE module
documentation:</p>
<p><strong>Example</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">sympy</span> <span class="kn">import</span> <span class="n">Function</span><span class="p">,</span> <span class="n">dsolve</span><span class="p">,</span> <span class="n">cos</span><span class="p">,</span> <span class="n">sin</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">sympy.abc</span> <span class="kn">import</span> <span class="n">x</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">sympy</span><span class="w"> </span><span class="kn">import</span> <span class="n">Function</span><span class="p">,</span> <span class="n">dsolve</span><span class="p">,</span> <span class="n">cos</span><span class="p">,</span> <span class="n">sin</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">sympy.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">x</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="n">Function</span><span class="p">(</span><span class="s1">&#39;f&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">dsolve</span><span class="p">(</span><span class="n">cos</span><span class="p">(</span><span class="n">f</span><span class="p">(</span><span class="n">x</span><span class="p">))</span> <span class="o">-</span> <span class="p">(</span><span class="n">x</span><span class="o">*</span><span class="n">sin</span><span class="p">(</span><span class="n">f</span><span class="p">(</span><span class="n">x</span><span class="p">))</span> <span class="o">-</span> <span class="n">f</span><span class="p">(</span><span class="n">x</span><span class="p">)</span><span class="o">**</span><span class="mi">2</span><span class="p">)</span><span class="o">*</span><span class="n">f</span><span class="p">(</span><span class="n">x</span><span class="p">)</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">x</span><span class="p">),</span>
<span class="gp">... </span><span class="n">f</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="n">hint</span><span class="o">=</span><span class="s1">&#39;1st_exact&#39;</span><span class="p">)</span>
Expand Down Expand Up @@ -1055,7 +1055,7 @@ <h3>4. Parameters Section<a class="headerlink" href="#parameters-section" title=
own heading.</p>
<p><strong>Example</strong></p>
<p>Here is an example of a correctly formatted Parameters section:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">opt_cse</span><span class="p">(</span><span class="n">exprs</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">&#39;canonical&#39;</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">opt_cse</span><span class="p">(</span><span class="n">exprs</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s1">&#39;canonical&#39;</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Find optimization opportunities in Adds, Muls, Pows and negative</span>
<span class="sd"> coefficient Muls.</span>
Expand Down Expand Up @@ -1093,7 +1093,7 @@ <h3>4. Parameters Section<a class="headerlink" href="#parameters-section" title=
<code class="docutils literal notranslate"><span class="pre">:class:`Classname`</span></code>, but rather only by their class name.</p>
<p><strong>Examples</strong></p>
<p>Here is a correctly formatted See Also section with concise descriptions:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">erf</span><span class="p">(</span><span class="n">Function</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">erf</span><span class="p">(</span><span class="n">Function</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The Gauss error function.</span>

Expand All @@ -1111,7 +1111,7 @@ <h3>4. Parameters Section<a class="headerlink" href="#parameters-section" title=
</pre></div>
</div>
<p>Here is a correctly formatted See Also section with just a list of names:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">besselj</span><span class="p">(</span><span class="n">BesselBase</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">besselj</span><span class="p">(</span><span class="n">BesselBase</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Bessel function of the first kind.</span>

Expand Down Expand Up @@ -1175,7 +1175,7 @@ <h3>6. References Section<a class="headerlink" href="#references-section" title=
<section id="sample-docstring">
<h2>Sample Docstring<a class="headerlink" href="#sample-docstring" title="Link to this heading"></a></h2>
<p>Here is an example of a correctly formatted docstring:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">gamma</span><span class="p">(</span><span class="n">Function</span><span class="p">):</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">gamma</span><span class="p">(</span><span class="n">Function</span><span class="p">):</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The gamma function</span>

Expand Down Expand Up @@ -1507,7 +1507,7 @@ <h2>Importing Docstrings into the Sphinx Documentation<a class="headerlink" href

<a href="https://github.com/pradyunsg/furo">Furo</a>
<div class="last-updated">
Last updated on Jan 05, 2025</div>
Last updated on Jan 07, 2025</div>
</div>
<div class="right-details">
<div class="icons">
Expand Down
Loading

0 comments on commit 1759c11

Please sign in to comment.