DOC: Generate online documentation.

MilanSkocic · Apr 28, 2023 · c97a81d · c97a81d
1 parent 13308c1
commit c97a81d
Show file tree

Hide file tree

Showing 26 changed files with 208 additions and 62 deletions.
diff --git a/docs/_downloads/537a06a1baeb7fba25a9cf319048af82/codata.pdf b/docs/_downloads/537a06a1baeb7fba25a9cf319048af82/codata.pdf
diff --git a/docs/_sources/releases/0.7.0-notes.rst.txt b/docs/_sources/releases/0.7.0-notes.rst.txt
@@ -0,0 +1,26 @@
+Codata 0.7.0 Release Note
+============================
+
+Changes
+^^^^^^^^^^^^^^^
+
+* Migrate documentation from doxygen to sphinx+breathe.
+* Add YEAR constant indicating the year of the codata constants.
+* Refractoring
+
+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.6.0...0.7.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.7.0-notes.rst
     0.6.0-notes.rst
     0.5.0-notes.rst
     0.4.0-notes.rst

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.6.0',
+    VERSION: '0.7.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/api/codata.html b/docs/api/codata.html
@@ -6,7 +6,7 @@
     <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.6.0 documentation</title>
+    <title>codata &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Autogenerated Documentation"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Autogenerated Documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">codata</a></li> 
       </ul>
@@ -1163,7 +1163,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Autogenerated Documentation"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Autogenerated Documentation</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
@@ -6,7 +6,7 @@
     <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>Autogenerated Documentation &#8212; codata 0.6.0 documentation</title>
+    <title>Autogenerated Documentation &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,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.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Autogenerated Documentation</a></li> 
       </ul>
     </div>  
@@ -101,7 +101,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.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Autogenerated Documentation</a></li> 
       </ul>
     </div>

diff --git a/docs/api/pycodata.html b/docs/api/pycodata.html
@@ -6,7 +6,7 @@
     <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.6.0 documentation</title>
+    <title>pycodata &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -27,7 +27,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.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Autogenerated Documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pycodata</a></li> 
       </ul>
@@ -86,7 +86,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.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Autogenerated Documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pycodata</a></li> 
       </ul>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; codata 0.6.0 documentation</title>
+    <title>Index &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -22,7 +22,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="#" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>  
@@ -66,7 +66,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="#" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>

diff --git a/docs/getting_started/codata.html b/docs/getting_started/codata.html
@@ -6,7 +6,7 @@
     <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.6.0 documentation</title>
+    <title>codata &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Getting Started"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Getting Started</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">codata</a></li> 
       </ul>
@@ -49,7 +49,7 @@ <h1>codata<a class="headerlink" href="#codata" title="Permalink to this heading"
 declarations as constants for different languages:</p>
 <ul class="simple">
 <li><p>Fortran module named <cite>fcodata.f90</cite></p></li>
-<li><p>C header named <cite>ccodata.</cite></p></li>
+<li><p>C header named <cite>ccodata.h</cite></p></li>
 <li><p>Python module named <cite>pycodata.py</cite></p></li>
 <li><p>CPython extension named <cite>cpycodata.c</cite></p></li>
 </ul>
@@ -137,7 +137,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="Getting Started"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Getting Started</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">codata</a></li> 
       </ul>

diff --git a/docs/getting_started/examples.html b/docs/getting_started/examples.html
@@ -6,7 +6,7 @@
     <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>Examples &#8212; codata 0.6.0 documentation</title>
+    <title>Examples &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pycodata.html" title="pycodata"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Getting Started</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Examples</a></li> 
       </ul>
@@ -96,7 +96,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pycodata.html" title="pycodata"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Getting Started</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Examples</a></li> 
       </ul>

diff --git a/docs/getting_started/index.html b/docs/getting_started/index.html
@@ -6,7 +6,7 @@
     <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>Getting Started &#8212; codata 0.6.0 documentation</title>
+    <title>Getting Started &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../index.html" title="Welcome to codata documentation!"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Getting Started</a></li> 
       </ul>
     </div>  
@@ -112,7 +112,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../index.html" title="Welcome to codata documentation!"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Getting Started</a></li> 
       </ul>
     </div>

diff --git a/docs/getting_started/pycodata.html b/docs/getting_started/pycodata.html
@@ -6,7 +6,7 @@
     <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.6.0 documentation</title>
+    <title>pycodata &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,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.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Getting Started</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pycodata</a></li> 
       </ul>
@@ -127,7 +127,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.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Getting Started</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">pycodata</a></li> 
       </ul>

diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
     <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>Welcome to codata documentation! &#8212; codata 0.6.0 documentation</title>
+    <title>Welcome to codata documentation! &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/classic.css" />
 
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="getting_started/index.html" title="Getting Started"
              accesskey="N">next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Welcome to codata documentation!</a></li> 
       </ul>
     </div>  
@@ -107,7 +107,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="getting_started/index.html" title="Getting Started"
              >next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="#">codata 0.7.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Welcome to codata documentation!</a></li> 
       </ul>
     </div>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/releases/0.1.0-notes.html b/docs/releases/0.1.0-notes.html
@@ -6,7 +6,7 @@
     <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 0.1.0 Release Note &#8212; codata 0.6.0 documentation</title>
+    <title>Codata 0.1.0 Release Note &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="0.2.0-notes.html" title="Codata 0.2.0 Release Note"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Release Notes</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Codata 0.1.0 Release Note</a></li> 
       </ul>
@@ -132,7 +132,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="0.2.0-notes.html" title="Codata 0.2.0 Release Note"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Release Notes</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Codata 0.1.0 Release Note</a></li> 
       </ul>

diff --git a/docs/releases/0.2.0-notes.html b/docs/releases/0.2.0-notes.html
@@ -6,7 +6,7 @@
     <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 0.2.0 Release Note &#8212; codata 0.6.0 documentation</title>
+    <title>Codata 0.2.0 Release Note &#8212; codata 0.7.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="0.2.1-notes.html" title="Codata 0.2.1 Release Note"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Release Notes</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Codata 0.2.0 Release Note</a></li> 
       </ul>
@@ -130,7 +130,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="0.2.1-notes.html" title="Codata 0.2.1 Release Note"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.6.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../index.html">codata 0.7.0 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="index.html" >Release Notes</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Codata 0.2.0 Release Note</a></li> 
       </ul>