update install instructions

Signed-off-by: Christopher M. Cantalupo <[email protected]>

GEOPM_CXX_MAN_Agent.3.html

@@ -14,6 +14,7 @@
         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
         <script src="_static/jquery.js"></script>
         <script src="_static/underscore.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -159,9 +160,9 @@
            <div itemprop="articleBody">
 
   <section id="geopm-agent-3-geopm-agent-plugin-interface">
-<h1>geopm::Agent(3) -- GEOPM agent plugin interface<a class="headerlink" href="#geopm-agent-3-geopm-agent-plugin-interface" title="Permalink to this headline"></a></h1>
+<h1>geopm::Agent(3) -- GEOPM agent plugin interface<a class="headerlink" href="#geopm-agent-3-geopm-agent-plugin-interface" title="Permalink to this heading"></a></h1>
 <section id="namespaces">
-<h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this headline"></a></h2>
+<h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this heading"></a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">Agent</span></code> class and the <code class="docutils literal notranslate"><span class="pre">agent_factory()</span></code> function are members of
 the <code class="docutils literal notranslate"><span class="pre">namespace</span> <span class="pre">geopm</span></code>, but the full names, <code class="docutils literal notranslate"><span class="pre">geopm::Agent</span></code> and
 <code class="docutils literal notranslate"><span class="pre">geopm::agent_factory()</span></code>, have been abbreviated in this manual.
@@ -171,7 +172,7 @@ <h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this
 better rendering of this manual.</p>
 </section>
 <section id="synopsis">
-<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
+<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
 <p>#include <a class="reference external" href="https://github.com/geopm/geopm/blob/dev/src/Agent.hpp">&lt;geopm/Agent.hpp&gt;</a></p>
 <p>Link with <code class="docutils literal notranslate"><span class="pre">-lgeopm</span></code></p>
 <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">PluginFactory</span><span class="o">&lt;</span><span class="n">Agent</span><span class="o">&gt;</span><span class="w"> </span><span class="o">&amp;</span><span class="n">agent_factory</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span><span class="w"></span>
@@ -238,7 +239,7 @@ <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this head
 </div>
 </section>
 <section id="description">
-<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">Agent</span></code> class is an abstract pure virtual class that defines the
 fundamental procedures executed by the GEOPM runtime.  In general, the
 Agent is responsible for making decisions about how and what control the
@@ -287,7 +288,7 @@ <h2>Description<a class="headerlink" href="#description" title="Permalink to thi
 I/O implementations by different <code class="docutils literal notranslate"><span class="pre">Agent</span></code> classes.</p>
 </section>
 <section id="factory-accessor">
-<h2>Factory Accessor<a class="headerlink" href="#factory-accessor" title="Permalink to this headline"></a></h2>
+<h2>Factory Accessor<a class="headerlink" href="#factory-accessor" title="Permalink to this heading"></a></h2>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">agent_factory()</span></code>:
 This method returns the singleton accessor for the Agent factory.
@@ -297,7 +298,7 @@ <h2>Factory Accessor<a class="headerlink" href="#factory-accessor" title="Permal
 </ul>
 </section>
 <section id="class-methods">
-<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this headline"></a></h2>
+<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this heading"></a></h2>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">init()</span></code>:
 The <code class="docutils literal notranslate"><span class="pre">init()</span></code> method is the first method that will be called and
@@ -460,17 +461,17 @@ <h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to
 </ul>
 </section>
 <section id="errors">
-<h2>Errors<a class="headerlink" href="#errors" title="Permalink to this headline"></a></h2>
+<h2>Errors<a class="headerlink" href="#errors" title="Permalink to this heading"></a></h2>
 <p>All functions described on this man page throw <a class="reference internal" href="GEOPM_CXX_MAN_Exception.3.html"><span class="doc">geopm::Exception(3)</span></a>
 on error.</p>
 </section>
 <section id="example">
-<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline"></a></h2>
+<h2>Example<a class="headerlink" href="#example" title="Permalink to this heading"></a></h2>
 <p>Please see the <a class="reference external" href="https://github.com/geopm/geopm/tree/dev/tutorial/agent">Agent tutorial</a> for more
 information.  This code is located in the GEOPM source under tutorial/agent.</p>
 </section>
 <section id="see-also">
-<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
+<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2>
 <p><a class="reference internal" href="geopm.7.html"><span class="doc">geopm(7)</span></a></p>
 </section>
 </section>

GEOPM_CXX_MAN_Agg.3.html

@@ -14,6 +14,7 @@
         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
         <script src="_static/jquery.js"></script>
         <script src="_static/underscore.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -157,9 +158,9 @@
            <div itemprop="articleBody">
 
   <section id="geopm-agg-3-data-aggregation-functions">
-<h1>geopm::Agg(3) -- data aggregation functions<a class="headerlink" href="#geopm-agg-3-data-aggregation-functions" title="Permalink to this headline"></a></h1>
+<h1>geopm::Agg(3) -- data aggregation functions<a class="headerlink" href="#geopm-agg-3-data-aggregation-functions" title="Permalink to this heading"></a></h1>
 <section id="namespaces">
-<h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this headline"></a></h2>
+<h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this heading"></a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">Agg</span></code> class and the <code class="docutils literal notranslate"><span class="pre">Agg::m_type_e</span></code> struct are members of
 the <code class="docutils literal notranslate"><span class="pre">namespace</span> <span class="pre">geopm</span></code>, but the full names, <code class="docutils literal notranslate"><span class="pre">geopm::Agg</span></code> and
 <code class="docutils literal notranslate"><span class="pre">geopm::Agg::m_type_e</span></code>, have been abbreviated in this manual.
@@ -169,7 +170,7 @@ <h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this
 better rendering of this manual.</p>
 </section>
 <section id="synopsis">
-<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
+<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
 <p>#include <a class="reference external" href="https://github.com/geopm/geopm/blob/dev/service/src/geopm/Agg.hpp">&lt;geopm/Agg.hpp&gt;</a></p>
 <p>Link with <code class="docutils literal notranslate"><span class="pre">-lgeopm</span></code> <strong>(MPI)</strong> or <code class="docutils literal notranslate"><span class="pre">-lgeopmpolicy</span></code> <strong>(non-MPI)</strong></p>
 <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="nf">Agg::sum</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">vector</span><span class="o">&lt;</span><span class="kt">double</span><span class="o">&gt;</span><span class="w"> </span><span class="o">&amp;</span><span class="n">operands</span><span class="p">);</span><span class="w"></span>
@@ -209,15 +210,15 @@ <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this head
 </div>
 </section>
 <section id="description">
-<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
 <p>This class contains helper functions for aggregating multiple
 floating-point samples to a single number.  They can be used to
 simplify Agent implementation.</p>
 </section>
 <section id="enum-type">
-<h2>Enum Type<a class="headerlink" href="#enum-type" title="Permalink to this headline"></a></h2>
+<h2>Enum Type<a class="headerlink" href="#enum-type" title="Permalink to this heading"></a></h2>
 <p>Each of the following enum values corresponds to each of the aggregation helper functions.</p>
-<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">enum</span> <span class="nc">Agg</span><span class="o">::</span><span class="n">m_type_e</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">enum</span><span class="w"> </span><span class="nc">Agg</span><span class="o">::</span><span class="n">m_type_e</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
 <span class="w">    </span><span class="n">M_SUM</span><span class="p">,</span><span class="w"></span>
 <span class="w">    </span><span class="n">M_AVERAGE</span><span class="p">,</span><span class="w"></span>
 <span class="w">    </span><span class="n">M_MEDIAN</span><span class="p">,</span><span class="w"></span>
@@ -236,7 +237,7 @@ <h2>Enum Type<a class="headerlink" href="#enum-type" title="Permalink to this he
 </div>
 </section>
 <section id="class-methods">
-<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this headline"></a></h2>
+<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this heading"></a></h2>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">sum()</span></code>:
 Returns the sum of the input <em>operands</em>.</p></li>
@@ -297,7 +298,7 @@ <h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to
 </ul>
 </section>
 <section id="see-also">
-<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
+<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2>
 <p><a class="reference internal" href="geopm.7.html"><span class="doc">geopm(7)</span></a>,
 <a class="reference internal" href="geopm_hash.3.html"><span class="doc">geopm_hash(3)</span></a></p>
 </section>

GEOPM_CXX_MAN_CNLIOGroup.3.html

@@ -14,6 +14,7 @@
         <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
         <script src="_static/jquery.js"></script>
         <script src="_static/underscore.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
         <script src="_static/doctools.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -156,9 +157,9 @@
            <div itemprop="articleBody">
 
   <section id="geopm-cnliogroup-3-iogroup-for-interaction-with-compute-node-linux">
-<h1>geopm::CNLIOGroup(3) -- IOGroup for interaction with Compute Node Linux<a class="headerlink" href="#geopm-cnliogroup-3-iogroup-for-interaction-with-compute-node-linux" title="Permalink to this headline"></a></h1>
+<h1>geopm::CNLIOGroup(3) -- IOGroup for interaction with Compute Node Linux<a class="headerlink" href="#geopm-cnliogroup-3-iogroup-for-interaction-with-compute-node-linux" title="Permalink to this heading"></a></h1>
 <section id="namespaces">
-<h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this headline"></a></h2>
+<h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this heading"></a></h2>
 <p>The <code class="docutils literal notranslate"><span class="pre">CNLIOGroup</span></code> class and the <code class="docutils literal notranslate"><span class="pre">IOGroup</span></code> class are members of
 the <code class="docutils literal notranslate"><span class="pre">namespace</span> <span class="pre">geopm</span></code>, but the full names, <code class="docutils literal notranslate"><span class="pre">geopm::CNLIOGroup</span></code> and
 <code class="docutils literal notranslate"><span class="pre">geopm::IOGroup</span></code>, have been abbreviated in this manual.
@@ -168,7 +169,7 @@ <h2>Namespaces<a class="headerlink" href="#namespaces" title="Permalink to this
 better rendering of this manual.</p>
 </section>
 <section id="synopsis">
-<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
+<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
 <p>#include <a class="reference external" href="https://github.com/geopm/geopm/blob/dev/service/src/CNLIOGroup.hpp">&lt;geopm/CNLIOGroup.hpp&gt;</a></p>
 <p>Link with <code class="docutils literal notranslate"><span class="pre">-lgeopm</span></code> <strong>(MPI)</strong> or <code class="docutils literal notranslate"><span class="pre">-lgeopmpolicy</span></code> <strong>(non-MPI)</strong></p>
 <div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">set</span><span class="o">&lt;</span><span class="n">string</span><span class="o">&gt;</span><span class="w"> </span><span class="n">CNLIOGroup</span><span class="o">::</span><span class="n">signal_names</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="k">override</span><span class="p">;</span><span class="w"></span>
@@ -230,13 +231,13 @@ <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this head
 </div>
 </section>
 <section id="description">
-<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
+<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading"></a></h2>
 <p>The CNLIOGroup provides board-level energy counters from Compute Node Linux
 as signals. These values are obtained through the <code class="docutils literal notranslate"><span class="pre">/sys/cray/pm_counters</span></code> on
 Compute Node Linux systems.</p>
 </section>
 <section id="class-methods">
-<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this headline"></a></h2>
+<h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to this heading"></a></h2>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">signal_names()</span></code>:
 Returns the list of signal names provided by this IOGroup.</p></li>
@@ -310,7 +311,7 @@ <h2>Class Methods<a class="headerlink" href="#class-methods" title="Permalink to
 </ul>
 </section>
 <section id="see-also">
-<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
+<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading"></a></h2>
 <p><a class="reference internal" href="geopm.7.html"><span class="doc">geopm(7)</span></a>,
 <a class="reference internal" href="geopm_pio_cnl.7.html"><span class="doc">geopm_pio_cnl(7)</span></a>,
 <a class="reference external" href="https://man7.org/linux/man-pages/man5/proc.5.html">proc(5)</a>,