DOC: Generate online doc.

MilanSkocic · Apr 28, 2023 · 9bc4964 · 9bc4964
1 parent 6f1e0d8
commit 9bc4964
Show file tree

Hide file tree

Showing 21 changed files with 43 additions and 42 deletions.
diff --git a/docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf b/docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -74,7 +74,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/_modules/pyiapws/iapws.html b/docs/_modules/pyiapws/iapws.html
@@ -43,6 +43,7 @@ <h1>Source code for pyiapws.iapws</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">numpy.typing</span> <span class="kn">import</span> <span class="n">NDArray</span>
 <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">_iapws</span>
 
+
 <div class="viewcode-block" id="kh"><a class="viewcode-back" href="../../api/pyiapws.html#pyiapws.iapws.kh">[docs]</a><span class="k">def</span> <span class="nf">kh</span><span class="p">(</span><span class="n">temperature</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">],</span> <span class="n">gas</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">solvent</span><span class="p">:</span><span class="nb">str</span><span class="p">)</span><span class="o">-&gt;</span><span class="n">Union</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">NDArray</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Compute the Henry constant for the gas and solvent at temperature.</span>
@@ -59,7 +60,7 @@ <h1>Source code for pyiapws.iapws</h1><div class="highlight"><pre>
 <span class="sd">    Returns</span>
 <span class="sd">    --------</span>
 <span class="sd">    kh: float or array-like</span>
-<span class="sd">        Henry constant in GPa-1.</span>
+<span class="sd">        Henry constant.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">kh</span> <span class="o">=</span> <span class="n">_iapws</span><span class="o">.</span><span class="n">kh</span><span class="p">(</span><span class="n">temperature</span><span class="p">,</span> <span class="n">gas</span><span class="p">,</span> <span class="n">solvent</span><span class="p">)</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">kh</span><span class="p">,</span> <span class="nb">memoryview</span><span class="p">):</span>
@@ -83,7 +84,7 @@ <h1>Source code for pyiapws.iapws</h1><div class="highlight"><pre>
 <span class="sd">    Returns</span>
 <span class="sd">    --------</span>
 <span class="sd">    kd: float or array-like</span>
-<span class="sd">        Henry constant in GPa-1.</span>
+<span class="sd">        Henry constant.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">kd</span> <span class="o">=</span> <span class="n">_iapws</span><span class="o">.</span><span class="n">kd</span><span class="p">(</span><span class="n">temperature</span><span class="p">,</span> <span class="n">gas</span><span class="p">,</span> <span class="n">solvent</span><span class="p">)</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">kd</span><span class="p">,</span> <span class="nb">memoryview</span><span class="p">):</span>
@@ -129,7 +130,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/api/iapws.html b/docs/api/iapws.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>iapws &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -55,7 +55,7 @@ <h1>iapws<a class="headerlink" href="#iapws" title="Permalink to this heading">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
 <dl class="cpp function">
 <dt class="sig sig-object cpp">
-<span class="target" id="namespaceiapws_1a5efa40e32eb842713834ce64854061d8"></span><span class="sig-name descname"><span class="pre">pure</span> <span class="pre">real(real64)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_kh</span> <span class="pre">(T,</span> <span class="pre">gas,</span> <span class="pre">solvent)</span></span></dt>
+<span class="target" id="namespaceiapws_1a3332c46104887740dc06fe5b9167de92"></span><span class="sig-name descname"><span class="pre">pure</span> <span class="pre">real(real64)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_kh</span> <span class="pre">(t,</span> <span class="pre">gas,</span> <span class="pre">solvent)</span></span></dt>
 <dd><p>Compute the henry constant for a given temperature and gas in solvent. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -73,7 +73,7 @@ <h1>iapws<a class="headerlink" href="#iapws" title="Permalink to this heading">
 
 <dl class="cpp function">
 <dt class="sig sig-object cpp">
-<span class="target" id="namespaceiapws_1a77e113ed3735b982a70d68b09eb2602e"></span><span class="sig-name descname"><span class="pre">pure</span> <span class="pre">real(real64)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_kd</span> <span class="pre">(T,</span> <span class="pre">gas,</span> <span class="pre">solvent)</span></span></dt>
+<span class="target" id="namespaceiapws_1a1a0937b529edb298a3a4fa18192c8b84"></span><span class="sig-name descname"><span class="pre">pure</span> <span class="pre">real(real64)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_kd</span> <span class="pre">(t,</span> <span class="pre">gas,</span> <span class="pre">solvent)</span></span></dt>
 <dd><p>Compute the vapor-liquid constant for a given temperature and gas in solvent. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -100,7 +100,7 @@ <h1>iapws<a class="headerlink" href="#iapws" title="Permalink to this heading">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
 <dl class="cpp function">
 <dt class="sig sig-object cpp">
-<span class="target" id="namespaceiapws__capi_1aec1144574663c10181ab98ae2dc954f7"></span><span class="sig-name descname"><span class="pre">real(c_double)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_capi_kh</span> <span class="pre">(T,</span> <span class="pre">gas,</span> <span class="pre">solvent,</span> <span class="pre">size_gas,</span> <span class="pre">size_solvent)</span></span></dt>
+<span class="target" id="namespaceiapws__capi_1a48416f647f665a353c05cd3985fd63a3"></span><span class="sig-name descname"><span class="pre">real(c_double)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_capi_kh</span> <span class="pre">(t,</span> <span class="pre">gas,</span> <span class="pre">solvent,</span> <span class="pre">size_gas,</span> <span class="pre">size_solvent)</span></span></dt>
 <dd><p>Compute the henry constant for a given temperature and gas in solvent. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -120,7 +120,7 @@ <h1>iapws<a class="headerlink" href="#iapws" title="Permalink to this heading">
 
 <dl class="cpp function">
 <dt class="sig sig-object cpp">
-<span class="target" id="namespaceiapws__capi_1aa11c945d459b15c3a867cb305aa6cc3e"></span><span class="sig-name descname"><span class="pre">real(c_double)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_capi_kd</span> <span class="pre">(T,</span> <span class="pre">gas,</span> <span class="pre">solvent,</span> <span class="pre">size_gas,</span> <span class="pre">size_solvent)</span></span></dt>
+<span class="target" id="namespaceiapws__capi_1af9e2085699ea42893d6bbaf42e832ea4"></span><span class="sig-name descname"><span class="pre">real(c_double)</span> <span class="pre">function,</span> <span class="pre">public</span> <span class="pre">iapws_capi_kd</span> <span class="pre">(t,</span> <span class="pre">gas,</span> <span class="pre">solvent,</span> <span class="pre">size_gas,</span> <span class="pre">size_solvent)</span></span></dt>
 <dd><p>Compute the vapor-liquid constant for a given temperature and gas in solvent. </p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -203,7 +203,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/api/index.html b/docs/api/index.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>Autogenerated Documentation &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -117,7 +117,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/api/pyiapws.html b/docs/api/pyiapws.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>pyipaws &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -65,7 +65,7 @@ <h3>Navigation</h3>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><dl class="simple">
-<dt>kd: float or array-like</dt><dd><p>Henry constant in GPa-1.</p>
+<dt>kd: float or array-like</dt><dd><p>Henry constant.</p>
 </dd>
 </dl>
 </dd>
@@ -89,7 +89,7 @@ <h3>Navigation</h3>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><dl class="simple">
-<dt>kh: float or array-like</dt><dd><p>Henry constant in GPa-1.</p>
+<dt>kh: float or array-like</dt><dd><p>Henry constant.</p>
 </dd>
 </dl>
 </dd>
@@ -169,7 +169,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -132,7 +132,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/getting_started/examples.html b/docs/getting_started/examples.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>Examples &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -169,7 +169,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/getting_started/iapws.html b/docs/getting_started/iapws.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>iapw &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -182,7 +182,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/getting_started/index.html b/docs/getting_started/index.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>Getting Started &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -128,7 +128,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/getting_started/pyiapws.html b/docs/getting_started/pyiapws.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>pyiapws &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -52,8 +52,8 @@ <h1>pyiapws<a class="headerlink" href="#pyiapws" title="Permalink to this headin
 Follow the
 <a class="reference external" href="https://milanskocic.github.io/iapws/getting_started/introduction.html#how-to-install">installation instructions</a>.
 for compiling and installing the library.</p>
-<p>For now,the wrapper must be compiled on Linux, windows and MacOS platforms
-after installing the iapws library using the compiler that was used to compile your python interpreter.</p>
+<p>For now,the wrapper must be compiled after installing the iapws library
+using the compiler that was used to compile your python interpreter.</p>
 <section id="how-to-install">
 <h2>How to install<a class="headerlink" href="#how-to-install" title="Permalink to this heading">¶</a></h2>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>pyiapws
@@ -144,7 +144,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/iapws_theory/iapws_g704.html b/docs/iapws_theory/iapws_g704.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>IAPWS G7-04 &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -177,7 +177,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/iapws_theory/index.html b/docs/iapws_theory/index.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>IAPWS - Theoretical background &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
@@ -117,7 +117,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
     <title>Welcome to iapws documentation! &#8212; iapws 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
@@ -121,7 +121,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -98,7 +98,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright Copyright (C) 2023 Milan Skocic.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
     </div>
   </body>
 </html>