Skip to content

Commit 39901ba

Browse files
author
Documenter.jl
committed
build based on faa48ae
1 parent 8a7a518 commit 39901ba

23 files changed

Lines changed: 3059 additions & 3034 deletions

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-09-05T17:40:48","documenter_version":"1.14.1"}}
1+
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-09-07T16:35:18","documenter_version":"1.14.1"}}

dev/CHANGELOG/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/TODO/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/bib/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/docstrings/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@
9898
````</code></pre></li></ul><h3 id="Constants"><a class="docs-heading-anchor" href="#Constants">Constants</a><a id="Constants-1"></a><a class="docs-heading-anchor-permalink" href="#Constants" title="Permalink"></a></h3><ul><li><p><strong>Format:</strong> Use a single-line docstring with double quotes (<code>&quot;...&quot;</code>). Include a brief description, the symbol of the constant if standard (e.g., <code>μ₀</code>), its value, and its units using the <code>\\[unit\\]</code> format.</p><pre><code class="nohighlight hljs"> ```julia
9999
&quot;Magnetic constant (vacuum permeability), μ₀ = 4π * 1e-7 \\[H/m\\]].&quot;
100100
const μ₀ = 4π * 1e-7
101-
```</code></pre></li></ul><h2 id="Common-mistakes-to-avoid"><a class="docs-heading-anchor" href="#Common-mistakes-to-avoid">Common mistakes to avoid</a><a id="Common-mistakes-to-avoid-1"></a><a class="docs-heading-anchor-permalink" href="#Common-mistakes-to-avoid" title="Permalink"></a></h2><p>Double-check the docstrings to avoid these common errors:</p><ul><li><strong>Missing <code>@doc</code> for constructors:</strong> ALL constructors require the <code>@doc</code> macro before their definition.</li><li><strong>Incorrect struct field docstrings:</strong> Use single-line <code>&quot;...&quot;</code> <em>above</em> the field, not block <code>&quot;&quot;&quot;...&quot;&quot;&quot;</code> quotes or inline <code>#</code> comments.</li><li><strong>Incorrect section order:</strong> Follow the specified order for function docstring sections precisely.</li><li><strong>Hard-coding function names in examples:</strong> Always use <code>$(FUNCTIONNAME)</code>.</li><li><strong>Incorrect unit formatting:</strong> Ensure <code>\\[unit\\]</code> syntax is used everywhere except comments within <code>Examples</code> blocks (<code>[unit]</code>). Double-check escaping (<code>\\</code>) for LaTeX.</li><li><strong>Adding math formulas to non-<code>calc_</code> functions:</strong> Math blocks are <em>only</em> for functions prefixed with <code>calc_</code>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../validation/">« Validation module</a><a class="docs-footer-nextpage" href="../TODO/">TODO »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/Electa-Git/LineCableModels.jl">LineCableModels.jl</a> v0.1.1-DEV supported by the Etch Competence Hub of EnergyVille, financed by the Flemish Government.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Friday 5 September 2025 17:33">Friday 5 September 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
101+
```</code></pre></li></ul><h2 id="Common-mistakes-to-avoid"><a class="docs-heading-anchor" href="#Common-mistakes-to-avoid">Common mistakes to avoid</a><a id="Common-mistakes-to-avoid-1"></a><a class="docs-heading-anchor-permalink" href="#Common-mistakes-to-avoid" title="Permalink"></a></h2><p>Double-check the docstrings to avoid these common errors:</p><ul><li><strong>Missing <code>@doc</code> for constructors:</strong> ALL constructors require the <code>@doc</code> macro before their definition.</li><li><strong>Incorrect struct field docstrings:</strong> Use single-line <code>&quot;...&quot;</code> <em>above</em> the field, not block <code>&quot;&quot;&quot;...&quot;&quot;&quot;</code> quotes or inline <code>#</code> comments.</li><li><strong>Incorrect section order:</strong> Follow the specified order for function docstring sections precisely.</li><li><strong>Hard-coding function names in examples:</strong> Always use <code>$(FUNCTIONNAME)</code>.</li><li><strong>Incorrect unit formatting:</strong> Ensure <code>\\[unit\\]</code> syntax is used everywhere except comments within <code>Examples</code> blocks (<code>[unit]</code>). Double-check escaping (<code>\\</code>) for LaTeX.</li><li><strong>Adding math formulas to non-<code>calc_</code> functions:</strong> Math blocks are <em>only</em> for functions prefixed with <code>calc_</code>.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../validation/">« Validation module</a><a class="docs-footer-nextpage" href="../TODO/">TODO »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/Electa-Git/LineCableModels.jl">LineCableModels.jl</a> v0.1.1-DEV supported by the Etch Competence Hub of EnergyVille, financed by the Flemish Government.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.14.1 on <span class="colophon-date" title="Sunday 7 September 2025 16:28">Sunday 7 September 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/objects.inv

30 Bytes
Binary file not shown.

dev/reference/index.html

Lines changed: 123 additions & 120 deletions
Large diffs are not rendered by default.

dev/refs.bib

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
@misc{NIST:DLMF,
2+
key = {DLMF},
3+
title = {NIST Digital Library of Mathematical Functions},
4+
editor = {Olver, F. W. J. and Olde Daalhuis, A. B. and Lozier, D. W. and Schneider, B. I. and Boisvert, R. F. and Clark, C. W. and Miller, B. R. and Saunders, B. V. and Cohl, H. S. and McClain, M. A.},
5+
year = {2025},
6+
institution = {National Institute of Standards and Technology (NIST)},
7+
howpublished = {[{https://dlmf.nist.gov/}]({https://dlmf.nist.gov/}), Release 1.2.4 of 2025-03-15},
8+
url = {https://dlmf.nist.gov/},
9+
}
10+
11+
@ARTICLE{6897971,
12+
author={Vujević, Slavko and Lovrić, Dino and Boras, Vedran},
13+
journal={IEEE Transactions on Electromagnetic Compatibility},
14+
title={High-Accurate Numerical Computation of Internal Impedance of Cylindrical Conductors for Complex Arguments of Arbitrary Magnitude},
15+
year={2014},
16+
volume={56},
17+
number={6},
18+
pages={1431-1438},
19+
keywords={Impedance;Conductors;Approximation methods;Skin effect;Mathematical model;Computational modeling;Large complex arguments;modified Bessel functions;solid cylindrical conductor;tubular cylindrical conductor;Large complex arguments;modified Bessel functions;solid cylindrical conductor;tubular cylindrical conductor},
20+
doi={10.1109/TEMC.2014.2352398}}
21+
22+
123
@ARTICLE{5437464,
224
author={Papadopoulos, Theofilos A. and Tsiamitros, Dimitrios A. and Papagiannis, Grigoris K.},
325
journal={IEEE Transactions on Power Delivery},
@@ -10,17 +32,17 @@ @ARTICLE{5437464
1032
doi={10.1109/TPWRD.2009.2034797}
1133
}
1234

13-
@Article{app14198982,
14-
AUTHOR = {Riba, Jordi-Roger},
15-
TITLE = {The Role of AC Resistance of Bare Stranded Conductors for Developing Dynamic Line Rating Approaches},
16-
JOURNAL = {Applied Sciences},
17-
VOLUME = {14},
18-
YEAR = {2024},
19-
NUMBER = {19},
20-
ARTICLE-NUMBER = {8982},
21-
URL = {https://www.mdpi.com/2076-3417/14/19/8982},
22-
ISSN = {2076-3417},
23-
DOI = {10.3390/app14198982}
35+
@ARTICLE{app14198982,
36+
author = {Riba, Jordi-Roger},
37+
title = {The Role of AC Resistance of Bare Stranded Conductors for Developing Dynamic Line Rating Approaches},
38+
journal = {Applied Sciences},
39+
volume = {14},
40+
year = {2024},
41+
number = {19},
42+
article-number = {8982},
43+
url = {https://www.mdpi.com/2076-3417/14/19/8982},
44+
issn = {2076-3417},
45+
doi = {10.3390/app14198982}
2446
}
2547

2648
@ARTICLE{6521501,

dev/search_index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)