Skip to content

Commit

Permalink
docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@blazej-bucha
blazej-bucha committed Feb 8, 2024
1 parent 2aab214 commit d3fd440
Show file tree
Hide file tree
Showing 41 changed files with 43 additions and 43 deletions.
2 changes: 1 addition & 1 deletion docs/build/html/_sources/install_unix.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ From within Python, you can now work with PyHarm:
.. code-block:: python
>>> import pyharm as ph
>>> ph.misc.print_version()
>>> ph.misc.print_info()
>>> quit()
Deactivate the virtual environment from the shell:
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-charm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ <h1>charm<a class="headerlink" href="#charm" title="Permalink to this heading">#

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-crd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,7 @@ <h1>charm_crd</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-err.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@ <h1>charm_err<a class="headerlink" href="#charm-err" title="Permalink to this he

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-glob.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@ <h1>charm_glob</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-integ.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ <h1>charm_integ<a class="headerlink" href="#charm-integ" title="Permalink to thi

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-leg.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ <h1>charm_leg<a class="headerlink" href="#charm-leg" title="Permalink to this he

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-misc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ <h1>charm_misc<a class="headerlink" href="#charm-misc" title="Permalink to this

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-sha.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -600,7 +600,7 @@ <h1>charm_sha</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c-shc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1189,7 +1189,7 @@ <h1>charm_shc</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/api-c-shs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ <h1>charm_shs</h1>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The function does not use <code class="docutils literal notranslate"><span class="pre">cell-&gt;w</span></code>, so no constrains are applied.</p>
<p>The function does not use <code class="docutils literal notranslate"><span class="pre">pnt-&gt;w</span></code>, so no constrains are applied.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down Expand Up @@ -929,7 +929,7 @@ <h1>charm_shs</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ <h1>CHarm (C API)</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-crd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1512,7 +1512,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-glob.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-integ.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -592,7 +592,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-leg.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -787,7 +787,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-misc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-sha.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-shc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1159,7 +1159,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py-shs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ <h2> Contents </h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api-py.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,7 @@ <h1>PyHarm (Python API)</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ <h1>Interfaces</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/benchmarks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ <h2>Memory<a class="headerlink" href="#memory" title="Permalink to this heading"

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/citing.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ <h1>Citing<a class="headerlink" href="#citing" title="Permalink to this heading"

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/cookbook-c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1730,7 +1730,7 @@ <h3>Example compilation in quadruple precision<a class="headerlink" href="#examp

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/cookbook-py.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1156,7 +1156,7 @@ <h3>Integrals<a class="headerlink" href="#integrals" title="Permalink to this he

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/cookbook.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ <h1>Cookbook</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/definitions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -817,7 +817,7 @@ <h2>References<a class="headerlink" href="#references" title="Permalink to this

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1167,7 +1167,7 @@ <h2 id="Y">Y</h2>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ <h1>Welcome to CHarm<a class="headerlink" href="#welcome-to-charm" title="Permal

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/install.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ <h1>Installing</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/install_non_unix.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ <h1>Installation on Windows 10</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/build/html/install_unix.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -768,7 +768,7 @@ <h4>Example installation<a class="headerlink" href="#example-installation" title
</div>
<p>From within Python, you can now work with PyHarm:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">pyharm</span> <span class="k">as</span> <span class="nn">ph</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">ph</span><span class="o">.</span><span class="n">misc</span><span class="o">.</span><span class="n">print_version</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">ph</span><span class="o">.</span><span class="n">misc</span><span class="o">.</span><span class="n">print_info</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">quit</span><span class="p">()</span>
</pre></div>
</div>
Expand Down Expand Up @@ -891,7 +891,7 @@ <h3>Uninstallation<a class="headerlink" href="#id4" title="Permalink to this hea

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/introduction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ <h2>Other spherical-harmonic-based libraries<a class="headerlink" href="#other-s

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/license.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -476,7 +476,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headin

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/platforms.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ <h1>Tested platforms</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ <h1>Python Module Index</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ <h1>Search</h1>

<div class="footer-item">
<p class="last-updated">
Last updated on Feb 07, 2024.
Last updated on Feb 08, 2024.
<br/>
</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/src/install_unix.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ From within Python, you can now work with PyHarm:
.. code-block:: python
>>> import pyharm as ph
>>> ph.misc.print_version()
>>> ph.misc.print_info()
>>> quit()
Deactivate the virtual environment from the shell:
Expand Down
2 changes: 1 addition & 1 deletion src/shs/shs.h.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ extern "C"
* ultra-high degree of Bouguer and isostatic anomalies. Journal of Geodesy
* 86:499-520, doi: 10.1007/s00190-011-0533-4
*
* @note The function does not use ``cell->w``, so no constrains are applied.
* @note The function does not use ``pnt->w``, so no constrains are applied.
*
* @param[in] pnt Evaluation points, organized either as a **grid** or as
* **scattered points** (see ``charm@P@_point``).
Expand Down

0 comments on commit d3fd440

Please sign in to comment.