Skip to content

Commit 54c96a3

Browse files
author
toddkarin
committed
Add table of contents
1 parent 49e68d7 commit 54c96a3

File tree

2 files changed

+31
-11
lines changed

2 files changed

+31
-11
lines changed

docs/_sources/index.rst.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ The team would greatly appreciate feedback and suggestions. To comment, see the
1010

1111
.. include:: generated/version.rst
1212

13+
**Categories**
14+
15+
.. contents:: :local:
16+
1317
Abbreviations
1418
-------------
1519

docs/index.html

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,24 @@ <h1>PV Modeling Glossary<a class="headerlink" href="#pv-modeling-glossary" title
166166
<p>This page contains nomenclature for PV-relevant terms that are used in modeling and data analysis for PV systems. Terms are grouped by category. These definitions should be helpful for anyone writing software to analyze PV systems.</p>
167167
<p>The team would greatly appreciate feedback and suggestions. To comment, see the issues on the <a class="reference external" href="https://github.com/DuraMAT/pv-terms">pv-terms github repo</a>.</p>
168168
<p>Version: 0.1.2</p>
169+
<p><strong>Categories</strong></p>
170+
<div class="contents local topic" id="contents">
171+
<ul class="simple">
172+
<li><a class="reference internal" href="#abbreviations" id="id12">Abbreviations</a></li>
173+
<li><a class="reference internal" href="#optional-suffixes" id="id13">Optional Suffixes</a></li>
174+
<li><a class="reference internal" href="#location" id="id14">Location</a></li>
175+
<li><a class="reference internal" href="#atmosphere" id="id15">Atmosphere</a></li>
176+
<li><a class="reference internal" href="#solar-position" id="id16">Solar Position</a></li>
177+
<li><a class="reference internal" href="#dc-output" id="id17">DC Output</a></li>
178+
<li><a class="reference internal" href="#ac-output" id="id18">AC Output</a></li>
179+
<li><a class="reference internal" href="#inverter" id="id19">Inverter</a></li>
180+
<li><a class="reference internal" href="#irradiance" id="id20">Irradiance</a></li>
181+
<li><a class="reference internal" href="#pv-system" id="id21">PV System</a></li>
182+
<li><a class="reference internal" href="#module-parameters" id="id22">Module Parameters</a></li>
183+
</ul>
184+
</div>
169185
<div class="section" id="abbreviations">
170-
<h2>Abbreviations<a class="headerlink" href="#abbreviations" title="Permalink to this headline"></a></h2>
186+
<h2><a class="toc-backref" href="#id12">Abbreviations</a><a class="headerlink" href="#abbreviations" title="Permalink to this headline"></a></h2>
171187
<p>These abbreviations are used without expansion in the rest of the variables.</p>
172188
<blockquote>
173189
<div></div></blockquote>
@@ -202,7 +218,7 @@ <h2>Abbreviations<a class="headerlink" href="#abbreviations" title="Permalink to
202218
</ul>
203219
</div>
204220
<div class="section" id="optional-suffixes">
205-
<h2>Optional Suffixes<a class="headerlink" href="#optional-suffixes" title="Permalink to this headline"></a></h2>
221+
<h2><a class="toc-backref" href="#id13">Optional Suffixes</a><a class="headerlink" href="#optional-suffixes" title="Permalink to this headline"></a></h2>
206222
<p>These optional suffixes can be appended to a variable in order to further clarify which quantity the variable refers to. In the following * refers to another variable.</p>
207223
<p><strong>Suffixes specifying the object</strong></p>
208224
<blockquote>
@@ -235,7 +251,7 @@ <h2>Optional Suffixes<a class="headerlink" href="#optional-suffixes" title="Perm
235251
</ul>
236252
</div>
237253
<div class="section" id="location">
238-
<h2>Location<a class="headerlink" href="#location" title="Permalink to this headline"></a></h2>
254+
<h2><a class="toc-backref" href="#id14">Location</a><a class="headerlink" href="#location" title="Permalink to this headline"></a></h2>
239255
<p>These variables are associated with the location of the PV system.</p>
240256
<blockquote>
241257
<div></div></blockquote>
@@ -249,7 +265,7 @@ <h2>Location<a class="headerlink" href="#location" title="Permalink to this head
249265
</ul>
250266
</div>
251267
<div class="section" id="atmosphere">
252-
<h2>Atmosphere<a class="headerlink" href="#atmosphere" title="Permalink to this headline"></a></h2>
268+
<h2><a class="toc-backref" href="#id15">Atmosphere</a><a class="headerlink" href="#atmosphere" title="Permalink to this headline"></a></h2>
253269
<p>Atmosphere variables are related to weather conditions.</p>
254270
<blockquote>
255271
<div></div></blockquote>
@@ -267,7 +283,7 @@ <h2>Atmosphere<a class="headerlink" href="#atmosphere" title="Permalink to this
267283
</ul>
268284
</div>
269285
<div class="section" id="solar-position">
270-
<h2>Solar Position<a class="headerlink" href="#solar-position" title="Permalink to this headline"></a></h2>
286+
<h2><a class="toc-backref" href="#id16">Solar Position</a><a class="headerlink" href="#solar-position" title="Permalink to this headline"></a></h2>
271287
<p>These variables are related to the position of sun and the incidence angles with the PV array.</p>
272288
<blockquote>
273289
<div></div></blockquote>
@@ -280,7 +296,7 @@ <h2>Solar Position<a class="headerlink" href="#solar-position" title="Permalink
280296
</ul>
281297
</div>
282298
<div class="section" id="dc-output">
283-
<h2>DC Output<a class="headerlink" href="#dc-output" title="Permalink to this headline"></a></h2>
299+
<h2><a class="toc-backref" href="#id17">DC Output</a><a class="headerlink" href="#dc-output" title="Permalink to this headline"></a></h2>
284300
<p>These variables are related to the DC side of a PV power plant.</p>
285301
<blockquote>
286302
<div></div></blockquote>
@@ -297,7 +313,7 @@ <h2>DC Output<a class="headerlink" href="#dc-output" title="Permalink to this he
297313
</ul>
298314
</div>
299315
<div class="section" id="ac-output">
300-
<h2>AC Output<a class="headerlink" href="#ac-output" title="Permalink to this headline"></a></h2>
316+
<h2><a class="toc-backref" href="#id18">AC Output</a><a class="headerlink" href="#ac-output" title="Permalink to this headline"></a></h2>
301317
<p>These variables are related to the AC side of a PV power plant.</p>
302318
<blockquote>
303319
<div></div></blockquote>
@@ -322,7 +338,7 @@ <h2>AC Output<a class="headerlink" href="#ac-output" title="Permalink to this he
322338
</ul>
323339
</div>
324340
<div class="section" id="inverter">
325-
<h2>Inverter<a class="headerlink" href="#inverter" title="Permalink to this headline"></a></h2>
341+
<h2><a class="toc-backref" href="#id19">Inverter</a><a class="headerlink" href="#inverter" title="Permalink to this headline"></a></h2>
326342
<p>These parameters are related to the operation of inverters.</p>
327343
<blockquote>
328344
<div></div></blockquote>
@@ -347,7 +363,7 @@ <h2>Inverter<a class="headerlink" href="#inverter" title="Permalink to this head
347363
</ul>
348364
</div>
349365
<div class="section" id="irradiance">
350-
<h2>Irradiance<a class="headerlink" href="#irradiance" title="Permalink to this headline"></a></h2>
366+
<h2><a class="toc-backref" href="#id20">Irradiance</a><a class="headerlink" href="#irradiance" title="Permalink to this headline"></a></h2>
351367
<p>These variables denote irradiance in units of W/m^2.</p>
352368
<blockquote>
353369
<div></div></blockquote>
@@ -373,7 +389,7 @@ <h2>Irradiance<a class="headerlink" href="#irradiance" title="Permalink to this
373389
</ul>
374390
</div>
375391
<div class="section" id="pv-system">
376-
<h2>PV System<a class="headerlink" href="#pv-system" title="Permalink to this headline"></a></h2>
392+
<h2><a class="toc-backref" href="#id21">PV System</a><a class="headerlink" href="#pv-system" title="Permalink to this headline"></a></h2>
377393
<p>These variables are related to the operating current, voltage and power of PV cells, modules or arrays.</p>
378394
<blockquote>
379395
<div></div></blockquote>
@@ -397,7 +413,7 @@ <h2>PV System<a class="headerlink" href="#pv-system" title="Permalink to this he
397413
</ul>
398414
</div>
399415
<div class="section" id="module-parameters">
400-
<h2>Module Parameters<a class="headerlink" href="#module-parameters" title="Permalink to this headline"></a></h2>
416+
<h2><a class="toc-backref" href="#id22">Module Parameters</a><a class="headerlink" href="#module-parameters" title="Permalink to this headline"></a></h2>
401417
<p>Module parameters are primarily used to describe the electrical characteristic of a PV module.</p>
402418
<blockquote>
403419
<div></div></blockquote>

0 commit comments

Comments
 (0)