DOC: Generate online documentation.

MilanSkocic · Jan 20, 2024 · c9d86cf · c9d86cf
1 parent 99fdb71
commit c9d86cf
Show file tree

Hide file tree

Showing 107 changed files with 44,971 additions and 0 deletions.
diff --git a/docs/_downloads/537a06a1baeb7fba25a9cf319048af82/codata.pdf b/docs/_downloads/537a06a1baeb7fba25a9cf319048af82/codata.pdf
diff --git a/docs/_downloads/a3e9e0886b7059d4c553af028824283a/LICENSE.txt b/docs/_downloads/a3e9e0886b7059d4c553af028824283a/LICENSE.txt
diff --git a/docs/_downloads/aeeecbf1565d1f259d485137e17b99fb/LICENSE.txt b/docs/_downloads/aeeecbf1565d1f259d485137e17b99fb/LICENSE.txt
diff --git a/docs/_images/logo-codata.png b/docs/_images/logo-codata.png
diff --git a/docs/_sources/api/codata.rst.txt b/docs/_sources/api/codata.rst.txt
@@ -0,0 +1,33 @@
+.. _codataAPI:
+
+codata
+===============
+
+Fortran
+--------------
+
+`Fortran code API <../ford/index.html>`_
+
+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/index.rst.txt b/docs/_sources/api/index.rst.txt
@@ -0,0 +1,8 @@
+API
+==================================
+
+.. toctree::
+    :maxdepth: 2
+
+    codata.rst
+    pycodata.rst
diff --git a/docs/_sources/api/pycodata.rst.txt b/docs/_sources/api/pycodata.rst.txt
@@ -0,0 +1,7 @@
+pycodata
+================
+
+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/getting_started/codata.rst.txt b/docs/_sources/getting_started/codata.rst.txt
@@ -0,0 +1,25 @@
+codata
+==============
+
+.. image:: ../media/logo-codata.png
+  :width: 200
+  :align: center
+
+.. include:: ../../../../README.rst
+  :start-after: readme_inclusion_start
+  :end-before: readme_inclusion_end
+
+How to install
+^^^^^^^^^^^^^^^^^
+
+.. include:: ../../../../INSTALL.rst
+
+Dependencies
+^^^^^^^^^^^^^^^^^
+
+.. literalinclude:: ../../../../REQUIREMENTS.txt
+
+License
+^^^^^^^^^^^^^^^^^
+
+:download:`GNU General Public License v3 (GPLv3) <../../../../LICENSE.txt>`
diff --git a/docs/_sources/getting_started/examples.rst.txt b/docs/_sources/getting_started/examples.rst.txt
@@ -0,0 +1,23 @@
+Examples
+==========
+
+
+Example in Fortran
+--------------------
+
+.. literalinclude:: ../../../../example/example_in_f.f90
+    :language: Fortran
+
+Example in C
+--------------------
+
+.. literalinclude:: ../../../../example/example_in_c.c
+    :language: C
+
+Example in Python
+--------------------
+
+.. literalinclude:: ../../../../example/example_in_py.py
+    :lines: 4-
+    :language: python
+
diff --git a/docs/_sources/getting_started/index.rst.txt b/docs/_sources/getting_started/index.rst.txt
@@ -0,0 +1,15 @@
+Getting Started
+================
+
+.. only:: html
+
+  PDF documentation: :download:`codata <../../build/latex/codata.pdf>`. 
+
+Sources: https://github.com/MilanSkocic/codata
+
+.. toctree::
+    :maxdepth: 2
+
+    codata.rst
+    pycodata.rst
+    examples.rst
diff --git a/docs/_sources/getting_started/pycodata.rst.txt b/docs/_sources/getting_started/pycodata.rst.txt
@@ -0,0 +1,21 @@
+pycodata
+=========================
+
+.. include:: ../../../../pywrapper/README.rst
+  :start-after: readme_inclusion_start
+  :end-before: readme_inclusion_end
+
+How to install
+^^^^^^^^^^^^^^^
+
+.. include:: ../../../../pywrapper/INSTALL.rst
+
+Dependencies
+^^^^^^^^^^^^^^^
+
+.. literalinclude:: ../../../../pywrapper/requirements.txt
+
+License
+^^^^^^^^^^^^^^^
+
+:download:`GNU General Public License v3 (GPLv3) <../../../../pywrapper/LICENSE.txt>`
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,18 @@
+Welcome to codata documentation!
+=========================================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   getting_started/index.rst
+   releases/index.rst
+   api/index.rst
+
+
+.. only:: html
+
+   Search
+   ==================
+
+   * :ref:`search`
diff --git a/docs/_sources/releases/0.1.0-notes.rst.txt b/docs/_sources/releases/0.1.0-notes.rst.txt
@@ -0,0 +1,30 @@
+Codata 0.1.0 Release Note
+===============================
+
+Changes
+--------------
+
+Implementation of:
+
+* the parser of the codata raw data
+* the generator of the Fortran modules
+* the C API and C header
+* the python wrapper (will be moved to its repository next release).
+
+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.1.0 
diff --git a/docs/_sources/releases/0.10.0-notes.rst.txt b/docs/_sources/releases/0.10.0-notes.rst.txt
@@ -0,0 +1,29 @@
+Codata 0.10.0 Release Note
+============================
+
+Summary
+---------------
+
+* Remove remove generation of the version module.
+* Add tests using the test-drive framework.
+* Explicit parameter constants for Fortran and protected constants for C API.
+* Minor fixes in documentation.
+* Code cleanup.
+* Merge of all code for autogeneration in one file.
+
+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.9.0...0.10.0
diff --git a/docs/_sources/releases/0.2.0-notes.rst.txt b/docs/_sources/releases/0.2.0-notes.rst.txt
@@ -0,0 +1,27 @@
+Codata 0.2.0 Release Note
+=============================
+
+Changes
+-----------------------------
+
+* Bug fixes for the codata 2010.
+* Bug fixes in the tests linked to the codata 2010.
+* Add python wrapper for the number of constants method. 
+
+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.1.0...0.2.0 
diff --git a/docs/_sources/releases/0.2.1-notes.rst.txt b/docs/_sources/releases/0.2.1-notes.rst.txt
@@ -0,0 +1,26 @@
+Codata 0.2.1 Release Note
+=============================
+
+Changes
+----------------------------
+
+* Integration of Intel Fortran compiler and MSVC in cmake scripts.
+* Add specifications and instructions for compiling on Windows 
+
+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.2.0...0.2.1 
diff --git a/docs/_sources/releases/0.3.0-notes.rst.txt b/docs/_sources/releases/0.3.0-notes.rst.txt
@@ -0,0 +1,25 @@
+Codata 0.3.0 Release Note
+===========================================
+
+Changes
+-------------------------------------------
+
+* Only last codata constants. 
+
+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.2.1...0.3.0 
diff --git a/docs/_sources/releases/0.4.0-notes.rst.txt b/docs/_sources/releases/0.4.0-notes.rst.txt
@@ -0,0 +1,26 @@
+Codata 0.4.0 Release Note
+===========================================
+
+Changes
+-------------------------------------------
+
+* Bring back pywrapper in the codata repository to sync versions.
+* Improvements of the 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.3.0...0.4.0 
diff --git a/docs/_sources/releases/0.5.0-notes.rst.txt b/docs/_sources/releases/0.5.0-notes.rst.txt
@@ -0,0 +1,27 @@
+Codata 0.5.0 Release Note
+============================
+
+Changes
+----------------------------
+
+* Changed the complete approach by not generating a library but only source files for different languages.
+* Available languages: Fortran, C, python, CPython
+
+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.4.0...0.5.0
diff --git a/docs/_sources/releases/0.6.0-notes.rst.txt b/docs/_sources/releases/0.6.0-notes.rst.txt
@@ -0,0 +1,25 @@
+Codata 0.6.0 Release Note
+============================
+
+Changes
+---------------
+
+* Created documentation.
+* Fixed missing uncertainties for Cpython.
+
+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.5.0...0.6.0