Update docs and hide internal mechanisms

Author: BrianMichell

README.md

@@ -19,6 +19,7 @@
 Welcome to **MDIO** - a descriptive format for energy data that is intended to reduce storage costs,  improve the efficiency of I/O and make energy data and workflows understandable and reproducible.
 
 **MDIO** schema definitions [here.](https://mdio-python.readthedocs.io/en/v1-new-schema/data_models/version_1.html)
+**MDIO** C++ API documentation [here.](https://tgsai.github.io/mdio-cpp/html/index.html)
 
 # Requied tools
 - CMake 3.24 *or better*

html/annotated.html

@@ -96,12 +96,10 @@
 <tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1CenteredBinHistogram.html" target="_self">CenteredBinHistogram</a></td><td class="desc"></td></tr>
 <tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1EdgeDefinedHistogram.html" target="_self">EdgeDefinedHistogram</a></td><td class="desc"></td></tr>
 <tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1SummaryStats.html" target="_self">SummaryStats</a></td><td class="desc"></td></tr>
-<tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1Dataset.html" target="_self">Dataset</a></td><td class="desc">The <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class The dataset represents a collection of variables sharing a common grid </td></tr>
-<tr id="row_0_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Dataset_1_1index__sequence.html" target="_self">index_sequence</a></td><td class="desc"></td></tr>
-<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1UserAttributes.html" target="_self">UserAttributes</a></td><td class="desc"></td></tr>
-<tr id="row_0_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="toggleFolder('0_3_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable.html" target="_self">Variable</a></td><td class="desc">A templated struct representing an MDIO <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> with a tensorstore. This is an MDIO specified zarr V2 tensorstore variable. It represents the non-volitile (on-disc, in-cloud, etc.) data </td></tr>
-<tr id="row_0_3_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1index__sequence.html" target="_self">index_sequence</a></td><td class="desc"></td></tr>
-<tr id="row_0_3_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1Interval.html" target="_self">Interval</a></td><td class="desc"></td></tr>
+<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1Dataset.html" target="_self">Dataset</a></td><td class="desc">The <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class The dataset represents a collection of variables sharing a common grid </td></tr>
+<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1UserAttributes.html" target="_self">UserAttributes</a></td><td class="desc"></td></tr>
+<tr id="row_0_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="toggleFolder('0_3_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable.html" target="_self">Variable</a></td><td class="desc">A templated struct representing an MDIO <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> with a tensorstore. This is an MDIO specified zarr V2 tensorstore variable. It represents the non-volitile (on-disc, in-cloud, etc.) data </td></tr>
+<tr id="row_0_3_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1Interval.html" target="_self">Interval</a></td><td class="desc"></td></tr>
 <tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1VariableData.html" target="_self">VariableData</a></td><td class="desc">The in-memory representation of the data This object should only be constructed through the <a class="el" href="structmdio_1_1Variable.html#af425045bbd682a466383dcb99e244c6e" title="Read the data from the variable. Reads the data from the source variable. Provide an Open method for ...">Variable::Read()</a> function. This data only exists in memory and should be preserved with the <a class="el" href="structmdio_1_1Variable.html#ab4ba4f463cf01d9b0e410ab21e590a2b" title="Write the data to the variable. Writes the data from the source variable data to the target variable.">Variable::Write()</a> function </td></tr>
 <tr id="row_0_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1LabeledArray.html" target="_self">LabeledArray</a></td><td class="desc">A <a class="el" href="structmdio_1_1LabeledArray.html" title="A LabeledArray is an underlying data type for a VariableData object and is not intended to be directl...">LabeledArray</a> is an underlying data type for a <a class="el" href="structmdio_1_1VariableData.html" title="The in-memory representation of the data This object should only be constructed through the Variable:...">VariableData</a> object and is not intended to be directly interacted with </td></tr>
 <tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1RangeDescriptor.html" target="_self">RangeDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> </td></tr>

html/classes.html

@@ -104,7 +104,7 @@
 <dd><a class="el" href="classmdio_1_1internal_1_1Histogram.html">Histogram</a> (mdio::internal)</dd></dl>
 <dl class="classindex even">
 <dt class="alphachar"><a name="letter_I">I</a></dt>
-<dd><a class="el" href="structmdio_1_1Dataset_1_1index__sequence.html">Dataset::index_sequence</a> (<a class="el" href="namespacemdio.html">mdio</a>)</dd><dd><a class="el" href="structmdio_1_1Variable_1_1index__sequence.html">Variable::index_sequence</a> (<a class="el" href="namespacemdio.html">mdio</a>)</dd><dd><a class="el" href="structmdio_1_1Variable_1_1Interval.html">Variable::Interval</a> (<a class="el" href="namespacemdio.html">mdio</a>)</dd></dl>
+<dd><a class="el" href="structmdio_1_1Variable_1_1Interval.html">Variable::Interval</a> (<a class="el" href="namespacemdio.html">mdio</a>)</dd></dl>
 <dl class="classindex odd">
 <dt class="alphachar"><a name="letter_L">L</a></dt>
 <dd><a class="el" href="structmdio_1_1LabeledArray.html">LabeledArray</a> (<a class="el" href="namespacemdio.html">mdio</a>)</dd><dd><a class="el" href="structmdio_1_1ListDescriptor.html">ListDescriptor</a> (<a class="el" href="namespacemdio.html">mdio</a>)</dd></dl>