Skip to content

Commit

Permalink
Update documentation for docs-on-gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
tmadlener committed Jan 18, 2024
1 parent 05aa672 commit 3745ff0
Show file tree
Hide file tree
Showing 112 changed files with 253 additions and 67 deletions.
1 change: 1 addition & 0 deletions docs-on-gh-pages/ReleaseNotes.html
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
5 changes: 3 additions & 2 deletions docs-on-gh-pages/advanced_topics.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down Expand Up @@ -595,7 +596,7 @@ <h3>Dumping JSON<a class="headerlink" href="#dumping-json" title="Link to this h
<span class="p">};</span>
</pre></div>
</div>
<p>Each element of the collection will be converted to a JSON object, where the keys are the same as in the datamodel definiton.
<p>Each element of the collection will be converted to a JSON object, where the keys are the same as in the datamodel definition.
Components contained in the objects will similarly be similarly converted.</p>
<p><strong>JSON is not foreseen as a mode for persistency, i.e. there is no plan to add the conversion from JSON to the in memory representation of the datamodel.</strong></p>
</section>
Expand Down Expand Up @@ -698,7 +699,7 @@ <h4>The <code class="docutils literal notranslate"><span class="pre">DatamodelRe
refer to an <em>EDM</em> as the shared library (and the corresponding public headers)
that have been compiled from code that has been generated from a <em>datamodel
definition</em> in the original YAML file. In general whenever we refer to a
<em>datamodel</em> in this context we mean the enitity as a whole, i.e. its definition
<em>datamodel</em> in this context we mean the entity as a whole, i.e. its definition
in a YAML file, the concrete implementation as an EDM, as well as other related
information that is related to it.</p>
<p>Currently the <code class="docutils literal notranslate"><span class="pre">DatamodelRegistry</span></code> provides mainly access to the original
Expand Down
1 change: 1 addition & 0 deletions docs-on-gh-pages/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs-on-gh-pages/cpp_api/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down Expand Up @@ -541,7 +542,7 @@ <h1>Class podio::CollectionBufferFactory<a class="headerlink" href="#class-podio
<span id="_CPPv3N5podio23CollectionBufferFactoryE"></span><span id="_CPPv2N5podio23CollectionBufferFactoryE"></span><span id="podio::CollectionBufferFactory"></span><span class="target" id="classpodio_1_1_collection_buffer_factory"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CollectionBufferFactory</span></span></span><a class="headerlink" href="#_CPPv4N5podio23CollectionBufferFactoryE" title="Link to this definition"></a><br /></dt>
<dd><p>The CollectionBufferFactory allows to create buffers of known datatypes, which can then be populated by e.g. </p>
<p>readers. In order to support schema evolution, the buffers have a version and this factory will also require a schema version to create buffers.</p>
<p>It is implemented as a singleton, which is populated at the time a shared datamodel library is loaded. It is assumed that that happens early on in the startup of an appliation, such that only a single thread will access the factory instance for registering datatypes. Since the necessary creation functions are part of the core datamodel library, this should be very easy to achieve by simply linking to that library. Once the factory is populated it can be safely accessed from multiple threads concurrently to obtain buffers. </p>
<p>It is implemented as a singleton, which is populated at the time a shared datamodel library is loaded. It is assumed that that happens early on in the startup of an application, such that only a single thread will access the factory instance for registering datatypes. Since the necessary creation functions are part of the core datamodel library, this should be very easy to achieve by simply linking to that library. Once the factory is populated it can be safely accessed from multiple threads concurrently to obtain buffers. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
Expand Down Expand Up @@ -579,7 +580,7 @@ <h1>Class podio::CollectionBufferFactory<a class="headerlink" href="#class-podio
<dd class="field-odd"><ul class="simple">
<li><p><strong>collType</strong> – The collection type name (e.g. from collection-&gt;getTypeName()) </p></li>
<li><p><strong>version</strong> – The schema version the created buffers should have </p></li>
<li><p><strong>susbsetColl</strong> – Should the buffers be for a subset collection or not</p></li>
<li><p><strong>subsetColl</strong> – Should the buffers be for a subset collection or not</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
1 change: 1 addition & 0 deletions docs-on-gh-pages/cpp_api/class/classpodio_1_1_frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down Expand Up @@ -611,7 +612,7 @@ <h1>Class podio::GenericParameters<a class="headerlink" href="#class-podio-gener
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N5podio17GenericParameters8setValueERKNSt6stringENSt6vectorINSt6stringEEE">
<span id="_CPPv3N5podio17GenericParameters8setValueERKNSt6stringENSt6vectorINSt6stringEEE"></span><span id="_CPPv2N5podio17GenericParameters8setValueERKNSt6stringENSt6vectorINSt6stringEEE"></span><span id="podio::GenericParameters::setValue__ssCR.std::vector:ss:"></span><span class="target" id="classpodio_1_1_generic_parameters_1a4d01a311646f8f524fb7b7d9b0ed078a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">setValue</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">key</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">values</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5podio17GenericParameters8setValueERKNSt6stringENSt6vectorINSt6stringEEE" title="Link to this definition"></a><br /></dt>
<dd><p>Overlaod for catching initializer list setting of string vector values. </p>
<dd><p>Overload for catching initializer list setting of string vector values. </p>
</dd></dl>

<dl class="cpp function">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down Expand Up @@ -621,7 +622,7 @@ <h1>Class podio::ROOTFrameReader<a class="headerlink" href="#class-podio-rootfra
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK5podio15ROOTFrameReader22getAvailableCategoriesEv">
<span id="_CPPv3NK5podio15ROOTFrameReader22getAvailableCategoriesEv"></span><span id="_CPPv2NK5podio15ROOTFrameReader22getAvailableCategoriesEv"></span><span id="podio::ROOTFrameReader::getAvailableCategoriesC"></span><span class="target" id="classpodio_1_1_r_o_o_t_frame_reader_1a976e1303f48181b21372c3b3e287fd44"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getAvailableCategories</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5podio15ROOTFrameReader22getAvailableCategoriesEv" title="Link to this definition"></a><br /></dt>
<dd><p>Get the names of all the availalable Frame categories in the current file(s) </p>
<dd><p>Get the names of all the available Frame categories in the current file(s) </p>
</dd></dl>

<dl class="cpp function">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,7 @@
</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.AllWriters"><code class="docutils literal notranslate"><span class="pre">AllWriters</span></code></a></li>
<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>
Expand Down
Loading

0 comments on commit 3745ff0

Please sign in to comment.