[go: up one dir, main page]
Menu ▾ ▴

[19eff1]: / docs / ClamsPack.html  Maximize  Restore  History

Download this file

504 lines (398 with data), 49.7 kB 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
<!DOCTYPE html>

<html>



        <head>

            <meta charset="utf-8" />

            <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />

            <title>ClammingPy doc</title>

            <link rel="logo icon" href="./statics/clamming32x32.ico" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/wexa.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/layout.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/book.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/menu.css" type="text/css" />

            <link rel="stylesheet" href="./Whakerexa-1.0/wexa_statics/css/code.css" type="text/css" />

            <link rel="stylesheet" href="./statics/clamming.css" type="text/css" />



            <script src="./Whakerexa-1.0/wexa_statics/js/wexa.js" type="module"></script>

            <script src="./Whakerexa-1.0/wexa_statics/js/whakerpy/request.js" type="text/javascript"></script>

            <script src="./Whakerexa-1.0/wexa_statics/js/book.js" type="application/javascript"></script>

            <script type="module">

                window.Wexa.OnLoadManager.addLoadFunction(() => {

                    let book = new Book("main-content");

                    book.fill_table(false);

                });

            </script>

       </head>

       

       <body class="light">

        <header>



            <a role="button" class="skip" href="#main-content" aria-label="Go to main content">

                Go to main content

            </a>

            <nav>

                <ul>

                    <li>

                        <button role="menuitem" class="print-off" onclick="AccessibilityManager.switch_contrast_scheme()" aria-label="Change contrast">

                            <img class="nav-item-img" src="./Whakerexa-1.0/wexa_statics/icons/contrast_switcher.jpg" alt="Contrast" id="img-contrast"/>

                        </button>

                    </li>

                    <li>

                        <button class="print-off" role="menuitem" onclick="AccessibilityManager.switch_color_scheme()" aria-label="Change theme color" >

                            <img class="nav-item-img" src="./Whakerexa-1.0/wexa_statics/icons/theme_switcher.png" alt="Theme" id="img-theme"/>

                        </button>

                    </li>

                </ul>

            </nav>

        

    <h1>ClammingPy 2.0</h1>

        <p><img class="small-logo" src="./statics/clamming.png" alt="Software logo"/></p>

        <p><a class="external-link" href="https://sourceforge.net/projects/clamming/">https://sourceforge.net/projects/clamming/</a></p>

    </header>

    <nav id="nav-book" class="side-nav">

    <h1>ClammingPy 2.0</h1>

    <img class="small-logo center" src="./statics/clamming.png" alt=""/>

        <p><a class="external-link" href="https://sourceforge.net/projects/clamming/">https://sourceforge.net/projects/clamming/</a></p>

    <ul>

<li><a role="button" tabindex="0" aria-disabled="true"> &crarr; Prev. Module</a></li>

<li><a role="button" tabindex="0" href="ClamsClass.html"> &uarr; Prev. Class</a></li>

<li><a role="button" tabindex="0" href="index.html"> &#8962; Index</a></li>

<li><a role="button" tabindex="0" href="ClamsModules.html"> &darr; Next Class</a></li>

<li><a role="button" tabindex="0" href="tests.html"> &rdsh; Next Module</a></li>

    </ul>

    <h2>Table of Contents</h2>

    <ul id="toc"></ul>

    <hr>

    <p><small>Automatically created</small></p><p><small>by <a class="external-link" href="https://clamming.sf.net">ClammingPy</a></small></p>

</nav>

    <main id="main-content">

    <section id="#clamming">    <h1>Module clamming</h1>

<section id="#ClamsPack">

<h2>Class ClamsPack</h2>



<section>

<h3 id="#description_ClamsPack">Description</h3>

    <article class="docstring">

<p><em>Create documentation of a module into Markdown or HTML.</em></p>



<h5>Example</h5>



<div class="highlight"><pre><span></span><code> <span class="o">&gt;&gt;&gt;</span> <span class="n">clams</span> <span class="o">=</span> <span class="n">ClamsPack</span><span class="p">(</span><span class="n">clamming</span><span class="p">)</span>

 <span class="o">&gt;&gt;&gt;</span> <span class="n">md</span> <span class="o">=</span> <span class="n">clams</span><span class="o">.</span><span class="n">markdown</span><span class="p">()</span>

</code></pre></div>



    </article>

</section>

<section>

<h3 id="#constructor_ClamsPack">Constructor</h3>

    <article class="docstring">

<p><em>Create documentation from the given package name.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>pack</strong>: (module) A Python module</li>

</ul>



<h5>Raises</h5>



<ul>

<li><em>TypeError</em>: given 'pack' is not a module</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pack</span><span class="p">:</span> <span class="n">Any</span><span class="p">):</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Create documentation from the given package name.</span>



<span class="sd">    :param pack: (module) A Python module</span>

<span class="sd">    :raises: TypeError: given &#39;pack&#39; is not a module</span>



<span class="sd">    &quot;&quot;&quot;</span>

    <span class="k">if</span> <span class="n">inspect</span><span class="o">.</span><span class="n">ismodule</span><span class="p">(</span><span class="n">pack</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>

        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">&#39;Expected a Python module. Got </span><span class="si">{:s}</span><span class="s1"> instead.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">pack</span><span class="p">)))</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__pack</span> <span class="o">=</span> <span class="n">pack</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>

    <span class="k">try</span><span class="p">:</span>

        <span class="k">for</span> <span class="n">class_name</span> <span class="ow">in</span> <span class="n">pack</span><span class="o">.</span><span class="n">__all__</span><span class="p">:</span>

            <span class="n">class_inst</span> <span class="o">=</span> <span class="n">ClamUtils</span><span class="o">.</span><span class="n">get_class</span><span class="p">(</span><span class="n">class_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__pack</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>

            <span class="k">if</span> <span class="n">class_inst</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

                <span class="n">clammer</span> <span class="o">=</span> <span class="n">ClammingClassParser</span><span class="p">(</span><span class="n">class_inst</span><span class="p">)</span>

                <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ClamsClass</span><span class="p">(</span><span class="n">clammer</span><span class="p">))</span>

    <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>

        <span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">&#39;Attribute __all__ is missing in package </span><span class="si">{:s}</span><span class="s1"> =&gt; No auto documentation.&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__pack</span><span class="o">.</span><span class="vm">__name__</span><span class="p">))</span>

</code></pre></div>



    </details>





</section>

<section>

<h3 id="#public_fct_ClamsPack">Public functions</h3>

<h4>get_name</h4>



    <article class="docstring">

<p><em>Return the name of the package.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the name of the package.&quot;&quot;&quot;</span>

    <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__pack</span><span class="o">.</span><span class="vm">__name__</span>

</code></pre></div>



    </details>





<h4>get_readme</h4>



    <article class="docstring">

<p><em>Return the content of the README file of the package, if any.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_readme</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the content of the README file of the package, if any.&quot;&quot;&quot;</span>

    <span class="n">path_to_readme</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__pack</span><span class="o">.</span><span class="vm">__file__</span><span class="p">)</span>

    <span class="n">readme_content</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>

    <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">path_to_readme</span><span class="p">):</span>

        <span class="k">if</span> <span class="s1">&#39;readme&#39;</span> <span class="ow">in</span> <span class="n">f</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span>

            <span class="n">readme_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_to_readme</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span>

            <span class="k">try</span><span class="p">:</span>

                <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">readme_file</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>

                    <span class="n">readme_content</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

            <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>

                <span class="n">logging</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="s1">&#39;A README file was found but could not be read: </span><span class="si">{:s}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)))</span>

            <span class="k">break</span>

    <span class="k">return</span> <span class="n">readme_content</span>

</code></pre></div>



    </details>





<h4>markdown</h4>



    <article class="docstring">

<p><em>Return the documentation of the package as a standalone Markdown content.</em></p>

<h5>Parameters</h5>



<ul>

<li><strong>exporter</strong></li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">markdown</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exporter</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the documentation of the package as a standalone Markdown content.</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="n">md</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>

    <span class="n">md</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;# </span><span class="si">{:s}</span><span class="s1"> module</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

    <span class="k">if</span> <span class="n">exporter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

        <span class="k">if</span> <span class="n">exporter</span><span class="o">.</span><span class="n">readme</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">HTML</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>

            <span class="n">readme_content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_readme</span><span class="p">()</span>

            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">readme_content</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>

                <span class="n">md</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">readme_content</span><span class="p">)</span>

    <span class="n">md</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;## List of classes</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

    <span class="k">for</span> <span class="n">clams</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">:</span>

        <span class="n">md</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">clams</span><span class="o">.</span><span class="n">markdown</span><span class="p">())</span>

    <span class="n">md</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n\n</span><span class="s1">~ Created using [Clamming](https://clamming.sf.net) version </span><span class="si">{:s}</span><span class="s1"> ~</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">clamming</span><span class="o">.</span><span class="n">__version__</span><span class="p">))</span>

    <span class="k">return</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">md</span><span class="p">)</span>

</code></pre></div>



    </details>





<h4>html</h4>



    <article class="docstring">

<p><em>Return the documentation of the package as an HTML content.</em></p>

<h5>Parameters</h5>



<ul>

<li><strong>exporter</strong></li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">html</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exporter</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the documentation of the package as an HTML content.&quot;&quot;&quot;</span>

    <span class="n">html</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>

    <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;&lt;h1&gt;</span><span class="si">{:s}</span><span class="s1"> module&lt;/h1&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

    <span class="k">if</span> <span class="n">exporter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

        <span class="k">if</span> <span class="n">exporter</span><span class="o">.</span><span class="n">readme</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">HTML</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>

            <span class="n">readme_content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_readme</span><span class="p">()</span>

            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">readme_content</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>

                <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;section id=&quot;readme&quot;&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

                <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ClamUtils</span><span class="p">()</span><span class="o">.</span><span class="n">markdown_to_html</span><span class="p">(</span><span class="n">readme_content</span><span class="p">))</span>

                <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;/section&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

    <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;&lt;h2&gt;List of classes&lt;/h2&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

    <span class="k">for</span> <span class="n">clams</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">:</span>

        <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">clams</span><span class="o">.</span><span class="n">html</span><span class="p">())</span>

    <span class="n">html</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n\n</span><span class="s1">&lt;p&gt;~ Created using &lt;a href=&quot;https://clamming.sf.net&quot;&gt;ClammingPy&lt;/a&gt; version </span><span class="si">{:s}</span><span class="s1"> ~&lt;/p&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">clamming</span><span class="o">.</span><span class="n">__version__</span><span class="p">))</span>

    <span class="k">return</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">html</span><span class="p">)</span>

</code></pre></div>



    </details>





<h4>html_index</h4>



    <article class="docstring">

<p><em>Create the HTML content of an index for the package.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>path_name</strong>: (<em>str</em>) Path where the exported HTML files are, or None for a standalone content.</li>

<li><strong>exporter</strong>: (HTMLDocExport) Options for HTML output files</li>

</ul>



<h5>Returns</h5>



<ul>

<li>(<em>str</em>) HTML code</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">html_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">exporter</span><span class="p">:</span> <span class="n">ExportOptions</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Create the HTML content of an index for the package.</span>



<span class="sd">        :param path_name: (str) Path where the exported HTML files are, or None for a standalone content.</span>

<span class="sd">        :param exporter: (HTMLDocExport) Options for HTML output files</span>

<span class="sd">        :return: (str) HTML code</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="n">out</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;section id=&quot;#</span><span class="si">{:s}</span><span class="s1">&quot;&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;h1&gt;</span><span class="si">{:s}</span><span class="s1"> module&lt;/h1&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

    <span class="k">if</span> <span class="n">exporter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

        <span class="k">if</span> <span class="n">exporter</span><span class="o">.</span><span class="n">readme</span> <span class="ow">is</span> <span class="kc">True</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">HTML</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>

            <span class="n">readme_content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_readme</span><span class="p">()</span>

            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">readme_content</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>

                <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;section id=&quot;readme&quot;&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

                <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ClamUtils</span><span class="p">()</span><span class="o">.</span><span class="n">markdown_to_html</span><span class="p">(</span><span class="n">readme_content</span><span class="p">))</span>

                <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;/section&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;&lt;h2&gt;List of classes&lt;/h2&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;        &lt;section class=&quot;cards-panel&quot;&gt;&#39;</span><span class="p">)</span>

    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">)):</span>

        <span class="n">clams</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;        &lt;article class=&quot;card&quot;&gt;&#39;</span><span class="p">)</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;            &lt;header&gt;&lt;span&gt;</span><span class="si">{:d}</span><span class="s1">&lt;/span&gt;&lt;/header&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">))</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;            &lt;main&gt;&#39;</span><span class="p">)</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;                &lt;h3&gt;</span><span class="si">{:s}</span><span class="s1">&lt;/h3&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">clams</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;            &lt;/main&gt;&#39;</span><span class="p">)</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;            &lt;footer&gt;&#39;</span><span class="p">)</span>

        <span class="k">if</span> <span class="n">path_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

            <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;                &lt;a role=&quot;button&quot; href=&quot;</span><span class="si">{:s}</span><span class="s1">&quot;&gt;Read me →&lt;/a&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_name</span><span class="p">,</span> <span class="n">clams</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;.html&#39;</span><span class="p">)))</span>

        <span class="k">else</span><span class="p">:</span>

            <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;                &lt;a role=&quot;button&quot; href=&quot;#</span><span class="si">{:s}</span><span class="s1">&quot;&gt;Read me →&lt;/a&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">clams</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;            &lt;/footer&gt;&#39;</span><span class="p">)</span>

        <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;        &lt;/article&gt;&#39;</span><span class="p">)</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;        &lt;/section&gt;&#39;</span><span class="p">)</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;    &lt;/section&gt;&#39;</span><span class="p">)</span>

    <span class="k">return</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>

</code></pre></div>



    </details>





<h4>html_export_clams</h4>



    <article class="docstring">

<p><em>Create the HTML pages of all classes of the package.</em></p>



<h5>Parameters</h5>



<ul>

<li><strong>path_name</strong>: (<em>str</em>) Path where to add the exported HTML files</li>

<li><strong>exporter</strong>: (HTMLDocExport) Options for HTML output files</li>

</ul>



<h5>Returns</h5>



<ul>

<li>(<em>list</em>) Exported file names</li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">html_export_clams</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">exporter</span><span class="p">:</span> <span class="n">ExportOptions</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Create the HTML pages of all classes of the package.</span>



<span class="sd">        :param path_name: (str) Path where to add the exported HTML files</span>

<span class="sd">        :param exporter: (HTMLDocExport) Options for HTML output files</span>

<span class="sd">        :return: (list) Exported file names</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="n">out</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>

    <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path_name</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>

        <span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">path_name</span><span class="p">)</span>

    <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Export module index&#39;</span><span class="p">)</span>

    <span class="n">out_html</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;.html&#39;</span><span class="p">)</span>

    <span class="bp">self</span><span class="o">.</span><span class="n">__module_index</span><span class="p">(</span><span class="n">out_html</span><span class="p">,</span> <span class="n">exporter</span><span class="p">)</span>

    <span class="n">out</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">out_html</span><span class="p">)</span>

    <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">)):</span>

        <span class="n">clams</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>

        <span class="n">out_html</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path_name</span><span class="p">,</span> <span class="n">clams</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;.html&#39;</span><span class="p">)</span>

        <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Export </span><span class="si">{:s}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">out_html</span><span class="p">))</span>

        <span class="n">exporter</span><span class="o">.</span><span class="n">prev_class</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">if</span> <span class="n">i</span> <span class="o">==</span> <span class="mi">0</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">[</span><span class="n">i</span> <span class="o">-</span> <span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;.html&#39;</span>

        <span class="n">exporter</span><span class="o">.</span><span class="n">next_class</span> <span class="o">=</span> <span class="kc">None</span> <span class="k">if</span> <span class="n">i</span> <span class="o">+</span> <span class="mi">1</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">)</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">[</span><span class="n">i</span> <span class="o">+</span> <span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;.html&#39;</span>

        <span class="n">html_content</span> <span class="o">=</span> <span class="n">clams</span><span class="o">.</span><span class="n">html</span><span class="p">()</span>

        <span class="bp">self</span><span class="o">.</span><span class="n">__module_class</span><span class="p">(</span><span class="n">out_html</span><span class="p">,</span> <span class="n">exporter</span><span class="p">,</span> <span class="n">html_content</span><span class="p">)</span>

    <span class="k">return</span> <span class="n">out</span>

</code></pre></div>



    </details>





</section>

<section>

<h3 id="#protected_fct_ClamsPack">Protected functions</h3>

<h4>__module_index</h4>



    <article class="docstring">

<p><em>Export an index for the module.</em></p>

<h5>Parameters</h5>



<ul>

<li><strong>out_html</strong></li>

<li><strong>exporter</strong></li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">__module_index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out_html</span><span class="p">,</span> <span class="n">exporter</span><span class="p">):</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Export an index for the module.</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="k">with</span> <span class="n">codecs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">out_html</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;!DOCTYPE html&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;html&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_head</span><span class="p">())</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;body class=&quot;</span><span class="si">{:s}</span><span class="s1">&quot;&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_theme</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">{:s}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_header</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">{:s}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_nav</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;main id=&quot;main-content&quot;&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">html_index</span><span class="p">(</span><span class="n">path_name</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">exporter</span><span class="o">=</span><span class="n">exporter</span><span class="p">))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;/main&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">{:s}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_footer</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;/body&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;/html&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

</code></pre></div>



    </details>





<h4>__module_class</h4>



    <article class="docstring">

<p><em>Export a content for the module.</em></p>

<h5>Parameters</h5>



<ul>

<li><strong>out_html</strong></li>

<li><strong>exporter</strong></li>

<li><strong>content</strong></li>

</ul>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">__module_class</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">out_html</span><span class="p">,</span> <span class="n">exporter</span><span class="p">,</span> <span class="n">content</span><span class="p">):</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Export a content for the module.</span>



<span class="sd">        &quot;&quot;&quot;</span>

    <span class="k">with</span> <span class="n">codecs</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">out_html</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">,</span> <span class="s1">&#39;utf-8&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;!DOCTYPE html&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;html&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_head</span><span class="p">())</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;body class=&quot;</span><span class="si">{:s}</span><span class="s1">&quot;&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_theme</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">{:s}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_header</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">{:s}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_nav</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;main id=&quot;main-content&quot;&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;section id=&quot;#</span><span class="si">{:s}</span><span class="s1">&quot;&gt;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;h1&gt;Module </span><span class="si">{:s}</span><span class="s1">&lt;/h1&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">content</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;/section&gt;&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    &lt;/main&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;    </span><span class="si">{:s}</span><span class="se">\n</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">exporter</span><span class="o">.</span><span class="n">get_footer</span><span class="p">()))</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;/body&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

        <span class="n">fp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;&lt;/html&gt;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>

</code></pre></div>



    </details>





</section>

<section>

<h3 id="#overloads_ClamsPack">Overloads</h3>

<h4>__len__</h4>



    <article class="docstring">

<p><em>Return the number of documented pages of the package.</em></p>



    </article>





    <details>

    <summary>

View Source

    </summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

<span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the number of documented pages of the package.&quot;&quot;&quot;</span>

    <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__clams</span><span class="p">)</span>

</code></pre></div>



    </details>





</section>

</section>    </section>    </main>

    

            <footer>

                <p class="copyright">Copyright (C) 2023-2025 Brigitte Bigi, CNRS, Laboratoire Parole et Langage, Aix-en-Provence, France</p>

            </footer>

        

</body>

</html>