Update documentation for docs-on-gh-pages

tmadlener · Jan 17, 2024 · 05aa672 · 05aa672
1 parent 91d474c
commit 05aa672
Show file tree

Hide file tree

Showing 113 changed files with 8,197 additions and 2,764 deletions.
diff --git a/docs-on-gh-pages/.buildinfo b/docs-on-gh-pages/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: bd5be014662d6bbcdd41a6b7ff178c06
+config: 013e586c1a2560c39b8c2aac31317198
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs-on-gh-pages/ReleaseNotes.html b/docs-on-gh-pages/ReleaseNotes.html
@@ -353,6 +353,10 @@
 <li class="toctree-l4"><a class="reference internal" href="cpp_api/struct/structpodio_1_1utils_1_1_maybe_shared_ptr_1_1_control_block.html#_CPPv4N5podio5utils14MaybeSharedPtr12ControlBlockE"><code class="docutils literal notranslate"><span class="pre">ControlBlock</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="cpp_api/struct/structpodio_1_1version_1_1_version.html">Struct podio::version::Version</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="cpp_api/struct/structpodio_1_1version_1_1_version.html#_CPPv4N5podio7version7VersionE"><code class="docutils literal notranslate"><span class="pre">Version</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="cpp_api/namespacelist.html">Namespace list</a><ul>
@@ -376,6 +380,10 @@
 <li class="toctree-l4"><a class="reference internal" href="cpp_api/namespace/namespacepodio_1_1utils.html#_CPPv4N5podio5utilsE"><code class="docutils literal notranslate"><span class="pre">utils</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="cpp_api/namespace/namespacepodio_1_1version.html">Namespace podio::version</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="cpp_api/namespace/namespacepodio_1_1version.html#_CPPv4N5podio7versionE"><code class="docutils literal notranslate"><span class="pre">version</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="cpp_api/namespace/namespacesio.html">Namespace sio</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="cpp_api/namespace/namespacesio.html#_CPPv43sio"><code class="docutils literal notranslate"><span class="pre">sio</span></code></a></li>
 </ul>
@@ -387,14 +395,45 @@
 <li class="toctree-l1"><a class="reference internal" href="py_api/modules.html">python</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="py_api/podio.html">podio package</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#submodules">Submodules</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-base-reader-module">podio.base_reader module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-base-writer-module">podio.base_writer module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-frame-module">podio.frame module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-frame-iterator-module">podio.frame_iterator module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-reading-module">podio.reading module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-root-io-module">podio.root_io module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-sio-io-module">podio.sio_io module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-contents">Module contents</a></li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.base_reader">podio.base_reader module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.base_reader.BaseReaderMixin"><code class="docutils literal notranslate"><span class="pre">BaseReaderMixin</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.base_writer">podio.base_writer module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.base_writer.BaseWriterMixin"><code class="docutils literal notranslate"><span class="pre">BaseWriterMixin</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.frame">podio.frame module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.frame.Frame"><code class="docutils literal notranslate"><span class="pre">Frame</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.frame_iterator">podio.frame_iterator module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.frame_iterator.FrameCategoryIterator"><code class="docutils literal notranslate"><span class="pre">FrameCategoryIterator</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.reading">podio.reading module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.reading.RootFileFormat"><code class="docutils literal notranslate"><span class="pre">RootFileFormat</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.reading.get_reader"><code class="docutils literal notranslate"><span class="pre">get_reader()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.root_io">podio.root_io module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.LegacyReader"><code class="docutils literal notranslate"><span class="pre">LegacyReader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.RNTupleReader"><code class="docutils literal notranslate"><span class="pre">RNTupleReader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.RNTupleWriter"><code class="docutils literal notranslate"><span class="pre">RNTupleWriter</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.Reader"><code class="docutils literal notranslate"><span class="pre">Reader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.Writer"><code class="docutils literal notranslate"><span class="pre">Writer</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.sio_io">podio.sio_io module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.sio_io.LegacyReader"><code class="docutils literal notranslate"><span class="pre">LegacyReader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.sio_io.Reader"><code class="docutils literal notranslate"><span class="pre">Reader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.sio_io.Writer"><code class="docutils literal notranslate"><span class="pre">Writer</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio">Module contents</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.Frame"><code class="docutils literal notranslate"><span class="pre">Frame</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="py_api/podio_class_generator.html">podio_class_generator module</a><ul>
@@ -3768,23 +3807,7 @@ <h1>v00-08<a class="headerlink" href="#v00-08" title="Link to this heading"><
       </div>
     </section>
   </div>
-
-<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
-  <span class="rst-current-version" data-toggle="rst-current-version">
-    <span class="fa fa-book"> Other Versions</span>
-    v: docs-on-gh-pages
-    <span class="fa fa-caret-down"></span>
-  </span>
-  <div class="rst-other-versions"><dl>
-      <dt>Versions</dt>
-      <dd><a href="ReleaseNotes.html">docs-on-gh-pages</a></dd>
-      <dd><a href="../master/ReleaseNotes.html">master</a></dd>
-      <dd><a href="../v00-00-00/ReleaseNotes.html">v00-00-00</a></dd>
-      <dd><a href="../v00-99/ReleaseNotes.html">v00-99</a></dd>
-      <dd><a href="../v99-99-99/ReleaseNotes.html">v99-99-99</a></dd>
-    </dl></div>
-</div>
-<script>
+  <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });

diff --git a/docs-on-gh-pages/advanced_topics.html b/docs-on-gh-pages/advanced_topics.html
@@ -355,6 +355,10 @@
 <li class="toctree-l4"><a class="reference internal" href="cpp_api/struct/structpodio_1_1utils_1_1_maybe_shared_ptr_1_1_control_block.html#_CPPv4N5podio5utils14MaybeSharedPtr12ControlBlockE"><code class="docutils literal notranslate"><span class="pre">ControlBlock</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="cpp_api/struct/structpodio_1_1version_1_1_version.html">Struct podio::version::Version</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="cpp_api/struct/structpodio_1_1version_1_1_version.html#_CPPv4N5podio7version7VersionE"><code class="docutils literal notranslate"><span class="pre">Version</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="cpp_api/namespacelist.html">Namespace list</a><ul>
@@ -378,6 +382,10 @@
 <li class="toctree-l4"><a class="reference internal" href="cpp_api/namespace/namespacepodio_1_1utils.html#_CPPv4N5podio5utilsE"><code class="docutils literal notranslate"><span class="pre">utils</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="cpp_api/namespace/namespacepodio_1_1version.html">Namespace podio::version</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="cpp_api/namespace/namespacepodio_1_1version.html#_CPPv4N5podio7versionE"><code class="docutils literal notranslate"><span class="pre">version</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l3"><a class="reference internal" href="cpp_api/namespace/namespacesio.html">Namespace sio</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="cpp_api/namespace/namespacesio.html#_CPPv43sio"><code class="docutils literal notranslate"><span class="pre">sio</span></code></a></li>
 </ul>
@@ -389,14 +397,45 @@
 <li class="toctree-l1"><a class="reference internal" href="py_api/modules.html">python</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="py_api/podio.html">podio package</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#submodules">Submodules</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-base-reader-module">podio.base_reader module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-base-writer-module">podio.base_writer module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-frame-module">podio.frame module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-frame-iterator-module">podio.frame_iterator module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-reading-module">podio.reading module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-root-io-module">podio.root_io module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#podio-sio-io-module">podio.sio_io module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-contents">Module contents</a></li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.base_reader">podio.base_reader module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.base_reader.BaseReaderMixin"><code class="docutils literal notranslate"><span class="pre">BaseReaderMixin</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.base_writer">podio.base_writer module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.base_writer.BaseWriterMixin"><code class="docutils literal notranslate"><span class="pre">BaseWriterMixin</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.frame">podio.frame module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.frame.Frame"><code class="docutils literal notranslate"><span class="pre">Frame</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.frame_iterator">podio.frame_iterator module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.frame_iterator.FrameCategoryIterator"><code class="docutils literal notranslate"><span class="pre">FrameCategoryIterator</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.reading">podio.reading module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.reading.RootFileFormat"><code class="docutils literal notranslate"><span class="pre">RootFileFormat</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.reading.get_reader"><code class="docutils literal notranslate"><span class="pre">get_reader()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.root_io">podio.root_io module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.LegacyReader"><code class="docutils literal notranslate"><span class="pre">LegacyReader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.RNTupleReader"><code class="docutils literal notranslate"><span class="pre">RNTupleReader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.RNTupleWriter"><code class="docutils literal notranslate"><span class="pre">RNTupleWriter</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.Reader"><code class="docutils literal notranslate"><span class="pre">Reader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.root_io.Writer"><code class="docutils literal notranslate"><span class="pre">Writer</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio.sio_io">podio.sio_io module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.sio_io.LegacyReader"><code class="docutils literal notranslate"><span class="pre">LegacyReader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.sio_io.Reader"><code class="docutils literal notranslate"><span class="pre">Reader</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.sio_io.Writer"><code class="docutils literal notranslate"><span class="pre">Writer</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="py_api/podio.html#module-podio">Module contents</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="py_api/podio.html#podio.Frame"><code class="docutils literal notranslate"><span class="pre">Frame</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="py_api/podio_class_generator.html">podio_class_generator module</a><ul>
@@ -732,23 +771,7 @@ <h4>I/O helpers for EDM definition storing<a class="headerlink" href="#i-o-helpe
       </div>
     </section>
   </div>
-
-<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
-  <span class="rst-current-version" data-toggle="rst-current-version">
-    <span class="fa fa-book"> Other Versions</span>
-    v: docs-on-gh-pages
-    <span class="fa fa-caret-down"></span>
-  </span>
-  <div class="rst-other-versions"><dl>
-      <dt>Versions</dt>
-      <dd><a href="advanced_topics.html">docs-on-gh-pages</a></dd>
-      <dd><a href="../master/advanced_topics.html">master</a></dd>
-      <dd><a href="../v00-00-00/advanced_topics.html">v00-00-00</a></dd>
-      <dd><a href="../v00-99/advanced_topics.html">v00-99</a></dd>
-      <dd><a href="../v99-99-99/advanced_topics.html">v99-99-99</a></dd>
-    </dl></div>
-</div>
-<script>
+  <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });