DOC: Generate online documentation.

MilanSkocic · Dec 17, 2023 · 2c68b0b · 2c68b0b
1 parent e18f82e
commit 2c68b0b
Show file tree

Hide file tree

Showing 50 changed files with 18,115 additions and 16,477 deletions.
diff --git a/docs/_downloads/537a06a1baeb7fba25a9cf319048af82/codata.pdf b/docs/_downloads/537a06a1baeb7fba25a9cf319048af82/codata.pdf
diff --git a/docs/_sources/api/codata.rst.txt b/docs/_sources/api/codata.rst.txt
@@ -11,5 +11,23 @@ Fortran
 C
 -------
 
+* `codata.h`: Main C header for the whole library.
+
 .. literalinclude:: ../../../../include/codata.h
+    :language: C
+
+Version
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* `codata_version.h`: C Header.
+
+.. literalinclude:: ../../../../include/codata_version.h
+    :language: C
+
+Constants
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* `codata_constants.h`: C Header.
+
+.. literalinclude:: ../../../../include/codata_constants.h
     :language: C
diff --git a/docs/_sources/api/pycodata.rst.txt b/docs/_sources/api/pycodata.rst.txt
@@ -1,7 +1,7 @@
 pycodata
 ================
 
-All constant as declared in the :ref:`codata <codataAPI>` are inserted at the top level 
+All constants as declared in the :ref:`codata <codataAPI>` are inserted at the top level 
 of the module.
 
 .. automodule:: pycodata
diff --git a/docs/_sources/releases/0.9.0-notes.rst.txt b/docs/_sources/releases/0.9.0-notes.rst.txt
@@ -0,0 +1,28 @@
+Codata 0.9.0 Release Note
+============================
+
+Summary
+---------------
+
+* No API changes.
+* Automatic generation of the version module.
+* Generic Makefiles for automatic the building process of the library and the pywrapper.
+* Add targets: build, build_debug, test, test_debug.
+* Minor fixes in documentation.
+
+Download
+---------------
+
+`Codata Releases <https://github.com/MilanSkocic/codata/releases>`_
+
+`PYPI <https://pypi.org/project/pycodata>`_
+
+
+Contributors
+---------------
+Milan Skocic
+
+Commits
+---------
+
+**Full Changelog**: https://github.com/MilanSkocic/codata/compare/0.8.2...0.9.0
diff --git a/docs/_sources/releases/index.rst.txt b/docs/_sources/releases/index.rst.txt
@@ -4,6 +4,7 @@ Release Notes
 .. toctree::
     :maxdepth: 1
 
+    0.9.0-notes.rst
     0.8.2-notes.rst
     0.8.1-notes.rst
     0.8.0-notes.rst

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.8.2',
+    VERSION: '0.9.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/api/codata.html b/docs/api/codata.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>codata &#8212; codata 0.8.2 documentation</title>
+    <title>codata &#8212; codata 0.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />
 
-    <script src="../_static/documentation_options.js?v=dbee5847"></script>
+    <script src="../_static/documentation_options.js?v=39bb1c6d"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="API"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">codata</a></li> 
       </ul>
@@ -51,11 +51,55 @@ <h2>Fortran<a class="headerlink" href="#fortran" title="Link to this heading">¶
 </section>
 <section id="c">
 <h2>C<a class="headerlink" href="#c" title="Link to this heading">¶</a></h2>
+<ul class="simple">
+<li><p><cite>codata.h</cite>: Main C header for the whole library.</p></li>
+</ul>
 <div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/**</span>
 <span class="cm">* @file</span>
-<span class="cm">* @brief Codata module - autogenerated.</span>
+<span class="cm">* @brief Main C header for the CODATA library.</span>
 <span class="cm">*/</span>
 
+<span class="cp">#ifndef CODATA_H</span>
+<span class="cp">#define CODATA_H</span>
+<span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;codata_version.h&quot;</span>
+<span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;codata_constants.h&quot;</span>
+<span class="cp">#endif</span>
+</pre></div>
+</div>
+<section id="version">
+<h3>Version<a class="headerlink" href="#version" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><cite>codata_version.h</cite>: C Header.</p></li>
+</ul>
+<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/**</span>
+<span class="cm">* @file</span>
+<span class="cm">* @brief Version - autogenerated.</span>
+<span class="cm">*/</span>
+
+<span class="cp">#ifndef codata_VERSION_H</span>
+<span class="cp">#define codata_VERSION_H</span>
+<span class="cp">#if _MSC_VER</span>
+<span class="cp">#define ADD_IMPORT __declspec(dllimport)</span>
+<span class="cp">#else</span>
+<span class="cp">#define ADD_IMPORT</span>
+<span class="cp">#endif</span>
+<span class="n">ADD_IMPORT</span><span class="w"> </span><span class="k">extern</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">codata_version_capi_version</span><span class="p">[</span><span class="w"> </span><span class="mi">6</span><span class="p">];</span>
+<span class="cp">#endif</span>
+</pre></div>
+</div>
+</section>
+<section id="constants">
+<h3>Constants<a class="headerlink" href="#constants" title="Link to this heading">¶</a></h3>
+<ul class="simple">
+<li><p><cite>codata_constants.h</cite>: C Header.</p></li>
+</ul>
+<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cm">/**</span>
+<span class="cm">* @file</span>
+<span class="cm">* @brief Constants - autogenerated.</span>
+<span class="cm">*/</span>
+
+<span class="cp">#ifndef codata_CONSTANTS_H</span>
+<span class="cp">#define codata_CONSTANTS_H</span>
 <span class="cp">#if _MSC_VER</span>
 <span class="cp">#define ADD_IMPORT __declspec(dllimport)</span>
 <span class="cp">#else</span>
@@ -1124,9 +1168,12 @@ <h2>C<a class="headerlink" href="#c" title="Link to this heading">¶</a></h2>
 
 <span class="n">ADD_IMPORT</span><span class="w"> </span><span class="k">extern</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="n">W_TO_Z_MASS_RATIO</span><span class="p">;</span><span class="cm">/**&lt;  */</span>
 <span class="n">ADD_IMPORT</span><span class="w"> </span><span class="k">extern</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="n">U_W_TO_Z_MASS_RATIO</span><span class="p">;</span><span class="cm">/**&lt;  */</span>
+
+<span class="cp">#endif</span>
 </pre></div>
 </div>
 </section>
+</section>
 </section>
 
 
@@ -1150,7 +1197,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="API"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">codata</a></li> 
       </ul>

diff --git a/docs/api/index.html b/docs/api/index.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>API &#8212; codata 0.8.2 documentation</title>
+    <title>API &#8212; codata 0.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />
 
-    <script src="../_static/documentation_options.js?v=dbee5847"></script>
+    <script src="../_static/documentation_options.js?v=39bb1c6d"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../releases/0.1.0-notes.html" title="Codata 0.1.0 Release Note"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.9.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">API</a></li> 
       </ul>
     </div>  
@@ -77,7 +77,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../releases/0.1.0-notes.html" title="Codata 0.1.0 Release Note"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.9.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">API</a></li> 
       </ul>
     </div>

diff --git a/docs/api/pycodata.html b/docs/api/pycodata.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>pycodata &#8212; codata 0.8.2 documentation</title>
+    <title>pycodata &#8212; codata 0.9.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />
 
-    <script src="../_static/documentation_options.js?v=dbee5847"></script>
+    <script src="../_static/documentation_options.js?v=39bb1c6d"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
 
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="codata.html" title="codata"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pycodata</a></li> 
       </ul>
@@ -41,7 +41,7 @@ <h3>Navigation</h3>
 
   <section id="pycodata">
 <h1>pycodata<a class="headerlink" href="#pycodata" title="Link to this heading">¶</a></h1>
-<p>All constant as declared in the <a class="reference internal" href="codata.html#codataapi"><span class="std std-ref">codata</span></a> are inserted at the top level
+<p>All constants as declared in the <a class="reference internal" href="codata.html#codataapi"><span class="std std-ref">codata</span></a> are inserted at the top level
 of the module.</p>
 <p id="module-pycodata">Python module containing the codata constants.</p>
 </section>
@@ -64,7 +64,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="codata.html" title="codata"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.8.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.9.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >API</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pycodata</a></li> 
       </ul>

diff --git a/docs/ford/index.html b/docs/ford/index.html
@@ -35,7 +35,7 @@
           <div id="navbar" class="navbar-collapse collapse">
             <ul class="navbar-nav">
                   <li class="nav-item">
-                    <a class="nav-link" href="./sourcefile/codata.f90.html">Source File</a>
+                    <a class="nav-link" href="./lists/files.html">Source Files</a>
                   </li>
                 <li class="nav-item">
                   <a class="nav-link" href="./lists/modules.html">Modules</a>
@@ -58,6 +58,7 @@
 	<p> Find us on&hellip;</p>
         <p>
           <a class="btn btn-lg btn-primary" href="https://github.com/MilanSkocic/codata" role="button">GitHub</a>
+          <a class="btn btn-lg btn-primary" href="https://milanskocic.github.io/codata/index.html" role="button">The Web</a>
           <a class="btn btn-lg btn-danger" style="float:right" href="https://github.com/MilanSkocic/codata/releases" role="button">Download the Source</a>
         </p>
       </div>
@@ -76,7 +77,6 @@ <h4 class="card-text">Milan Skocic</h4>
               <p class="card-text"></p>
                 <div class="text-center"><div class="btn-group" role="group">
                       <a class="btn btn-lg btn-primary" href="mailto:[email protected]"><i class="fa fa-envelope fa-lg"></i></a>
-                      <a class="btn btn-lg btn-primary" href="https://milanskocic.github.io/codata/index.html"><i class="fa fa-globe fa-lg"></i></a>
                       <a class="btn btn-lg btn-primary" href="https://github.com/MilanSkocic"><i class="fa fa-github fa-lg"></i></a>
                 </div></div>
             </div>
@@ -87,7 +87,7 @@ <h4 class="card-text">Milan Skocic</h4>
           <div class="col-xs-6 col-sm-6">
             <div>
               <h3>Source Files</h3>
-              <ul><li><a href='./sourcefile/codata.f90.html'>codata.f90</a></li></ul>
+              <ul><li><a href='./sourcefile/codata.f90.html'>codata.f90</a></li><li><a href='./sourcefile/codata_constants.f90.html'>codata_constants.f90</a></li><li><a href='./sourcefile/codata_version.f90.html'>codata_version.f90</a></li><li><a href='./sourcefile/codata_version_capi.f90.html'>codata_version_capi.f90</a></li></ul>
             </div>
             <div>
               <ul>
@@ -98,7 +98,7 @@ <h3>Source Files</h3>
           <div class="col-xs-6 col-sm-6">
             <div>
               <h3>Modules</h3>
-              <ul><li><a href='./module/codata.html'>codata</a></li></ul>
+              <ul><li><a href='./module/codata.html'>codata</a></li><li><a href='./module/codata__constants.html'>codata__constants</a></li><li><a href='./module/codata__version.html'>codata__version</a></li><li><a href='./module/codata__version_capi.html'>codata__version_capi</a></li></ul>
             </div>
             <div>
               <ul>
@@ -119,7 +119,7 @@ <h3>Modules</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2023-11-27T22:12:32.761027             </p>
+ on 2023-12-17T21:36:31.090116             </p>
           </div>
         </div>
         <br>