Skip to content

Commit e97c989

Browse files
author
pyocd-bot
committed
Deploying to main from @ pyocd/pyocd-website-source@3d2f0e3 🚀
1 parent 92d254c commit e97c989

24 files changed

+312
-144
lines changed

‎docs/README.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,11 +188,11 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Contents</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
<li class="toc-entry toc-h2"><a href="#table-of-contents">Table of Contents</a>
198198
<ul>
@@ -215,7 +215,7 @@ <h5 class="sidebar-header">Contents</h5>
215215
</ul>
216216
</div>
217217
</div>
218-
218+
219219
<h2 id="table-of-contents">Table of Contents</h2>
220220

221221
<h3 id="user-documentation">User documentation</h3>
@@ -276,7 +276,7 @@ <h4 id="architecture-and-design">Architecture and Design</h4>
276276
</div>
277277
</div>
278278
</main>
279-
279+
280280
</div>
281281
</div>
282282
</div>
@@ -348,7 +348,7 @@ <h5>Community</h5>
348348
</footer>
349349

350350
</div>
351-
351+
352352
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
353353
<i class="bi bi-arrow-up-short"></i>
354354
</a>
@@ -360,4 +360,11 @@ <h5>Community</h5>
360360
-->
361361

362362
</body>
363+
364+
<script>
365+
// Hide the page's floating TOC if there are no sections.
366+
if ($('#toc').children().length < 1) {
367+
$('#toc-div').hide()
368+
}
369+
</script>
363370
</html>

‎docs/adding_new_targets.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,19 +188,19 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Adding a new built-in target</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
<li class="toc-entry toc-h3"><a href="#device-family-pack-intro">Device Family Pack intro</a></li>
198198
<li class="toc-entry toc-h3"><a href="#steps-to-add-a-new-target">Steps to add a new target</a></li>
199199
<li class="toc-entry toc-h3"><a href="#steps-to-add-a-new-board">Steps to add a new board</a></li>
200200
</ul>
201201
</div>
202202
</div>
203-
203+
204204
<p>This guide describes how to manually add support for a new target and/or board to pyOCD. In most
205205
cases you do not need to add a builtin target anymore, and can use pyOCD’s support for CMSIS
206206
Device Family Packs.</p>
@@ -352,7 +352,7 @@ <h3 id="steps-to-add-a-new-board">Steps to add a new board</h3>
352352
</div>
353353
</div>
354354
</main>
355-
355+
356356
</div>
357357
</div>
358358
</div>
@@ -424,7 +424,7 @@ <h5>Community</h5>
424424
</footer>
425425

426426
</div>
427-
427+
428428
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
429429
<i class="bi bi-arrow-up-short"></i>
430430
</a>
@@ -436,4 +436,11 @@ <h5>Community</h5>
436436
-->
437437

438438
</body>
439+
440+
<script>
441+
// Hide the page's floating TOC if there are no sections.
442+
if ($('#toc').children().length < 1) {
443+
$('#toc-div').hide()
444+
}
445+
</script>
439446
</html>

‎docs/api_examples.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,19 +188,19 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Python API examples</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
<li class="toc-entry toc-h3"><a href="#hello-world-example-code">Hello World example code</a></li>
198198
<li class="toc-entry toc-h3"><a href="#elf-files-and-breakpoints">ELF files and breakpoints</a></li>
199199
<li class="toc-entry toc-h2"><a href="#alternative-ways-to-create-a-session">Alternative ways to create a session</a></li>
200200
</ul>
201201
</div>
202202
</div>
203-
203+
204204
<h3 id="hello-world-example-code">Hello World example code</h3>
205205

206206
<p>This example shows basic connection, loading a firmware binary, and some simple target control.</p>
@@ -338,7 +338,7 @@ <h2 id="alternative-ways-to-create-a-session">Alternative ways to create a sessi
338338
</div>
339339
</div>
340340
</main>
341-
341+
342342
</div>
343343
</div>
344344
</div>
@@ -410,7 +410,7 @@ <h5>Community</h5>
410410
</footer>
411411

412412
</div>
413-
413+
414414
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
415415
<i class="bi bi-arrow-up-short"></i>
416416
</a>
@@ -422,4 +422,11 @@ <h5>Community</h5>
422422
-->
423423

424424
</body>
425+
426+
<script>
427+
// Hide the page's floating TOC if there are no sections.
428+
if ($('#toc').children().length < 1) {
429+
$('#toc-div').hide()
430+
}
431+
</script>
425432
</html>

‎docs/architecture.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,11 +188,11 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Architecture</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
<li class="toc-entry toc-h2"><a href="#object-graph">Object graph</a></li>
198198
<li class="toc-entry toc-h2"><a href="#targets-and-boards">Targets and boards</a>
@@ -204,7 +204,7 @@ <h5 class="sidebar-header">Contents</h5>
204204
</ul>
205205
</div>
206206
</div>
207-
207+
208208
<h2 id="object-graph">Object graph</h2>
209209

210210
<p>The diagram below shows the most interesting parts of the pyOCD object graph, i.e. those parts
@@ -272,7 +272,7 @@ <h4 id="board-information">Board information</h4>
272272
</div>
273273
</div>
274274
</main>
275-
275+
276276
</div>
277277
</div>
278278
</div>
@@ -344,7 +344,7 @@ <h5>Community</h5>
344344
</footer>
345345

346346
</div>
347-
347+
348348
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
349349
<i class="bi bi-arrow-up-short"></i>
350350
</a>
@@ -356,4 +356,11 @@ <h5>Community</h5>
356356
-->
357357

358358
</body>
359+
360+
<script>
361+
// Hide the page's floating TOC if there are no sections.
362+
if ($('#toc').children().length < 1) {
363+
$('#toc-div').hide()
364+
}
365+
</script>
359366
</html>

‎docs/automated_tests.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,19 +188,19 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Automated tests</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
<li class="toc-entry toc-h2"><a href="#unit-tests">Unit tests</a></li>
198198
<li class="toc-entry toc-h2"><a href="#functional-tests">Functional tests</a></li>
199199
<li class="toc-entry toc-h2"><a href="#testing-with-tox">Testing with tox</a></li>
200200
</ul>
201201
</div>
202202
</div>
203-
203+
204204
<p>Both unit tests and functional tests are used to verify pyOCD.</p>
205205

206206
<p>The primary difference between unit tests and functional tests is that unit tests will work without
@@ -263,7 +263,7 @@ <h2 id="testing-with-tox">Testing with tox</h2>
263263
</div>
264264
</div>
265265
</main>
266-
266+
267267
</div>
268268
</div>
269269
</div>
@@ -335,7 +335,7 @@ <h5>Community</h5>
335335
</footer>
336336

337337
</div>
338-
338+
339339
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
340340
<i class="bi bi-arrow-up-short"></i>
341341
</a>
@@ -347,4 +347,11 @@ <h5>Community</h5>
347347
-->
348348

349349
</body>
350+
351+
<script>
352+
// Hide the page's floating TOC if there are no sections.
353+
if ($('#toc').children().length < 1) {
354+
$('#toc-div').hide()
355+
}
356+
</script>
350357
</html>

‎docs/builtin-targets.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,16 +188,16 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Built-in targets</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
</ul>
198198
</div>
199199
</div>
200-
200+
201201
<table>
202202

203203
<tr><th>Target Type Name</th><th>Vendor</th><th>Name</th></tr>
@@ -925,7 +925,7 @@ <h5 class="sidebar-header">Contents</h5>
925925
</div>
926926
</div>
927927
</main>
928-
928+
929929
</div>
930930
</div>
931931
</div>
@@ -997,7 +997,7 @@ <h5>Community</h5>
997997
</footer>
998998

999999
</div>
1000-
1000+
10011001
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
10021002
<i class="bi bi-arrow-up-short"></i>
10031003
</a>
@@ -1009,4 +1009,11 @@ <h5>Community</h5>
10091009
-->
10101010

10111011
</body>
1012+
1013+
<script>
1014+
// Hide the page's floating TOC if there are no sections.
1015+
if ($('#toc').children().length < 1) {
1016+
$('#toc-div').hide()
1017+
}
1018+
</script>
10121019
</html>

‎docs/command_reference.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,11 +188,11 @@ <h5 class="sidebar-header level-1">Developers</h5>
188188

189189
<h1 class="mb-4 mt-0">Command reference</h1>
190190

191-
191+
192192
<!-- floating table of contents -->
193-
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3">
193+
<div class="col-lg-4 col-md-3 float-md-end ms-md-3 mb-sm-3" id="toc-div">
194194
<div class="sidebar docs-sidebar-2 p-4">
195-
<h5 class="sidebar-header">Contents</h5>
195+
<h5 class="sidebar-header">On this page</h5>
196196
<ul id="toc" class="section-nav">
197197
<li class="toc-entry toc-h2"><a href="#all-commands">All commands</a></li>
198198
<li class="toc-entry toc-h2"><a href="#all-values">All values</a></li>
@@ -317,7 +317,7 @@ <h5 class="sidebar-header">Contents</h5>
317317
</ul>
318318
</div>
319319
</div>
320-
320+
321321
<p>PyOCD has a simple command processor that is accessible from the console via the commander subcommand,
322322
or from gdb as remote monitor commands.</p>
323323

@@ -1265,7 +1265,7 @@ <h5 id="show"><code class="highlighter-rouge">show</code></h5>
12651265
</div>
12661266
</div>
12671267
</main>
1268-
1268+
12691269
</div>
12701270
</div>
12711271
</div>
@@ -1337,7 +1337,7 @@ <h5>Community</h5>
13371337
</footer>
13381338

13391339
</div>
1340-
1340+
13411341
<a href="#top" title="Scroll to top" id="scroll-top-link" aria-hidden="true">
13421342
<i class="bi bi-arrow-up-short"></i>
13431343
</a>
@@ -1349,4 +1349,11 @@ <h5>Community</h5>
13491349
-->
13501350

13511351
</body>
1352+
1353+
<script>
1354+
// Hide the page's floating TOC if there are no sections.
1355+
if ($('#toc').children().length < 1) {
1356+
$('#toc-div').hide()
1357+
}
1358+
</script>
13521359
</html>

0 commit comments

Comments
 (0)