Skip to content

Commit

Permalink
DOC: Online doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@MilanSkocic
MilanSkocic committed Sep 8, 2023
1 parent dd72ea6 commit f1b0969
Show file tree
Hide file tree
Showing 60 changed files with 827 additions and 751 deletions.
Binary file modified docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf
View file
Binary file not shown.
Binary file modified docs/_images/g704_kd_D2O.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/g704_kd_H2O.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/g704_kh_D2O.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/g704_kh_H2O.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 11 additions & 12 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@

<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; iapws 0.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
<title>Overview: module code &#8212; iapws 0.2.1 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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand All @@ -25,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand All @@ -52,13 +51,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
</div>
</body>
</html>
28 changes: 28 additions & 0 deletions docs/_sources/releases/0.2.1-notes.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
iapws 0.2.1 Release Note
==================================

Summary
--------

* Comlete missing documentation of private functions.
* Minor fixes in C API code as well in python wrapper.
* Remove unecessary dependency in Makefile.

Download
----------

`iapws <https://github.com/MilanSkocic/iapws/releases>`_

`pyiapws <https://pypi.org/project/pyiapws>`_


Contributors
---------------

Milan Skocic


Commits
--------

Full Changelog: https://github.com/MilanSkocic/iapws/compare/0.2.0...0.2.1
1 change: 1 addition & 0 deletions docs/_sources/releases/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Release Notes
.. toctree::
:maxdepth: 1

0.2.1-notes.rst
0.2.0-notes.rst
0.1.1-notes.rst
0.1.0-notes.rst
22 changes: 22 additions & 0 deletions docs/_static/basic.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ a.headerlink {
visibility: hidden;
}

a:visited {
color: #551A8B;
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
Expand Down Expand Up @@ -670,6 +674,16 @@ dd {
margin-left: 30px;
}

.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}

.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}

dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
Expand Down Expand Up @@ -738,6 +752,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down
5 changes: 2 additions & 3 deletions docs/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '0.2.0',
const DOCUMENTATION_OPTIONS = {
VERSION: '0.2.1',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
26 changes: 17 additions & 9 deletions docs/_static/searchtools.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,12 @@ const _removeChildren = (element) => {
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string

const _displayItem = (item, searchTerms) => {
const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;

const [docName, title, anchor, descr, score, _filename] = item;

Expand All @@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
requestUrl = docUrlRoot + dirname;
requestUrl = contentRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = docUrlRoot + docName + docFileSuffix;
requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr)
if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
Expand All @@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
Expand All @@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
const _displayNextItem = (
results,
resultCount,
searchTerms
searchTerms,
highlightTerms,
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), searchTerms);
_displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout(
() => _displayNextItem(results, resultCount, searchTerms),
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5
);
}
Expand Down Expand Up @@ -360,7 +368,7 @@ const Search = {
// console.info("search results:", Search.lastresults);

// print the results
_displayNextItem(results, results.length, searchTerms);
_displayNextItem(results, results.length, searchTerms, highlightTerms);
},

/**
Expand Down
16 changes: 13 additions & 3 deletions docs/_static/sphinx_highlight.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
}

span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
rest,
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);

if (isInSVG) {
const rect = document.createElementNS(
Expand Down Expand Up @@ -140,5 +145,10 @@ const SphinxHighlight = {
},
};

_ready(SphinxHighlight.highlightSearchWords);
_ready(SphinxHighlight.initEscapeListener);
_ready(() => {
/* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});
31 changes: 15 additions & 16 deletions docs/api/iapws.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="../">
<head>
<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>iapws &#8212; iapws 0.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
<title>iapws &#8212; iapws 0.2.1 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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand All @@ -34,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">iapws 0.2.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 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="">iapws</a></li>
</ul>
Expand All @@ -45,13 +44,13 @@ <h3>Navigation</h3>
<div class="body" role="main">

<section id="iapws">
<h1>iapws<a class="headerlink" href="#iapws" title="Permalink to this heading"></a></h1>
<h1>iapws<a class="headerlink" href="#iapws" title="Link to this heading"></a></h1>
<section id="fortran">
<h2>Fortran<a class="headerlink" href="#fortran" title="Permalink to this heading"></a></h2>
<h2>Fortran<a class="headerlink" href="#fortran" title="Link to this heading"></a></h2>
<p><a class="reference external" href="../ford/index.html">Fortran code API</a></p>
</section>
<section id="c">
<h2>C<a class="headerlink" href="#c" title="Permalink to this heading"></a></h2>
<h2>C<a class="headerlink" href="#c" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><cite>iapws.h</cite>: Main C header for the whole library.</p></li>
</ul>
Expand All @@ -66,7 +65,7 @@ <h2>C<a class="headerlink" href="#c" title="Permalink to this heading">¶</a></h
</pre></div>
</div>
<section id="id1">
<h3>IAPWS G704: Gas solubilities<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<h3>IAPWS G704: Gas solubilities<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p><cite>iapws_g704.h</cite>: C header.</p></li>
</ul>
Expand Down Expand Up @@ -112,14 +111,14 @@ <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">iapws 0.2.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 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="">iapws</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
</div>
</body>
</html>
25 changes: 12 additions & 13 deletions docs/api/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

<!DOCTYPE html>

<html lang="en">
<html lang="en" data-content_root="../">
<head>
<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; iapws 0.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
<title>API &#8212; iapws 0.2.1 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 data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand All @@ -34,7 +33,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../releases/0.1.0-notes.html" title="iapws 0.1.0 Release Note"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API</a></li>
</ul>
</div>
Expand All @@ -44,7 +43,7 @@ <h3>Navigation</h3>
<div class="body" role="main">

<section id="api">
<h1>API<a class="headerlink" href="#api" title="Permalink to this heading"></a></h1>
<h1>API<a class="headerlink" href="#api" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="iapws.html">iapws</a><ul>
Expand Down Expand Up @@ -81,13 +80,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../releases/0.1.0-notes.html" title="iapws 0.1.0 Release Note"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.0 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.1.
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
</div>
</body>
</html>
Loading

0 comments on commit f1b0969

Please sign in to comment.