Skip to content

Commit

Permalink
deploy: 4e68308
Browse files Browse the repository at this point in the history
  • Loading branch information
@scottclowe
scottclowe committed Sep 15, 2024
1 parent 4e1ba58 commit 32a9df4
Show file tree
Hide file tree
Showing 7 changed files with 88 additions and 81 deletions.
47 changes: 24 additions & 23 deletions _static/basic.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}

a.brackets:after,
span.brackets > a:after {
content: "]";
}


h1:hover > a.headerlink,
h2:hover > a.headerlink,
Expand Down Expand Up @@ -334,11 +324,15 @@ aside.sidebar {
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;
Expand Down Expand Up @@ -377,13 +371,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 {
Expand Down Expand Up @@ -608,19 +606,26 @@ ol.simple p,
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;
}
Expand All @@ -636,10 +641,6 @@ dl.field-list > dt {
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}


dl.field-list > dd {
padding-left: 0.5em;
Expand Down
11 changes: 6 additions & 5 deletions changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Changelog &#8212; package-name 0.1.dev0 documentation</title>


Expand Down Expand Up @@ -310,17 +311,17 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<div class="section" id="changelog">
<section id="changelog">
<h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading">#</a></h1>
<p>All notable changes to package_name will be documented here.</p>
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>, and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
<p>Categories for changes are: Added, Changed, Deprecated, Removed, Fixed, Security.</p>
<div class="section" id="version-0-1-0">
<section id="version-0-1-0">
<h2>Version <a class="reference external" href="https://github.com/your_organisation/package_name/tree/0.1.0">0.1.0</a><a class="headerlink" href="#version-0-1-0" title="Permalink to this heading">#</a></h2>
<p>Release date: YYYY-MM-DD.
Initial release (to be released).</p>
</div>
</div>
</section>
</section>


</article>
Expand Down
3 changes: 2 additions & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>&lt;no title&gt; &#8212; package-name 0.1.dev0 documentation</title>


Expand Down
7 changes: 4 additions & 3 deletions packages/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>API Reference &#8212; package-name 0.1.dev0 documentation</title>


Expand Down Expand Up @@ -300,7 +301,7 @@ <h1>API Reference</h1>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<div class="section" id="api-reference">
<section id="api-reference">
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading">#</a></h1>
<div class="toctree-wrapper compound">
<ul>
Expand All @@ -316,7 +317,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
</li>
</ul>
</div>
</div>
</section>


</article>
Expand Down
11 changes: 6 additions & 5 deletions packages/package_name.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>package_name package &#8212; package-name 0.1.dev0 documentation</title>


Expand Down Expand Up @@ -310,9 +311,9 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<div class="section" id="module-package_name">
<section id="module-package_name">
<span id="package-name-package"></span><h1>package_name package<a class="headerlink" href="#module-package_name" title="Permalink to this heading">#</a></h1>
<div class="section" id="submodules">
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
Expand All @@ -322,8 +323,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</li>
</ul>
</div>
</div>
</div>
</section>
</section>


</article>
Expand Down
19 changes: 10 additions & 9 deletions packages/package_name.module.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>package_name.module module &#8212; package-name 0.1.dev0 documentation</title>


Expand Down Expand Up @@ -310,25 +311,25 @@ <h2> Contents </h2>
<div id="searchbox"></div>
<article class="bd-article" role="main">

<div class="section" id="module-package_name.module">
<section id="module-package_name.module">
<span id="package-name-module-module"></span><h1>package_name.module module<a class="headerlink" href="#module-package_name.module" title="Permalink to this heading">#</a></h1>
<p>Module provides a simple cubic_rectification function.</p>
<dl class="py function">
<dt class="sig sig-object py" id="package_name.module.cubic_rectification">
<span class="sig-prename descclassname"><span class="pre">package_name.module.</span></span><span class="sig-name descname"><span class="pre">cubic_rectification</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/package_name/module.html#cubic_rectification"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#package_name.module.cubic_rectification" title="Permalink to this definition">#</a></dt>
<dd><p>Rectified cube of an array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><em>numpy.ndarray</em></a>) – Input array.</p></li>
<li><p><strong>x</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><em>numpy.ndarray</em></a>) – Input array.</p></li>
<li><p><strong>verbose</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a><em>, </em><em>optional</em>) – Whether to print out details. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Elementwise, the cube of <cite>x</cite> where it is positive and <code class="docutils literal notranslate"><span class="pre">0</span></code> otherwise.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)">numpy.ndarray</a></p>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)">numpy.ndarray</a></p>
</dd>
</dl>
<div class="admonition note">
Expand All @@ -337,12 +338,12 @@ <h2> Contents </h2>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The use of intersphinx will cause <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a> to link to
<p>The use of intersphinx will cause <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><code class="xref py py-class docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a> to link to
the numpy documentation page.</p>
</div>
</dd></dl>

</div>
</section>


</article>
Expand Down
Loading

0 comments on commit 32a9df4

Please sign in to comment.