Skip to content

Commit 3b48567

Browse files
author
Documenter.jl
committed
build based on 1d6c76d
1 parent dc8a8e8 commit 3b48567

39 files changed

Lines changed: 574 additions & 1285820 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.12.2","generation_timestamp":"2025-11-24T19:16:30","documenter_version":"1.16.1"}}
1+
{"documenter":{"julia_version":"1.12.5","generation_timestamp":"2026-02-21T17:52:52","documenter_version":"1.17.0"}}

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/assets/documenter.js

Lines changed: 13 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/assets/warner.js

Lines changed: 61 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,40 @@ function maybeAddWarning() {
3737
closer.addEventListener("click", function () {
3838
document.body.removeChild(div);
3939
});
40-
const href = window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
40+
var target_href =
41+
window.documenterBaseURL + "/../" + window.DOCUMENTER_STABLE;
42+
43+
// try to stay on the same page when linking to the stable version
44+
// get the current page path relative to the version root
45+
var current_page = window.location.pathname;
46+
47+
// resolve the documenterBaseURL to an absolute path
48+
// documenterBaseURL is a relative path (usually "."), so we need to resolve it
49+
var base_url_absolute = new URL(documenterBaseURL, window.location.href)
50+
.pathname;
51+
if (!base_url_absolute.endsWith("/")) {
52+
base_url_absolute = base_url_absolute + "/";
53+
}
54+
55+
// extract the page path after the version directory
56+
// e.g., if we're on /stable/man/guide.html, we want "man/guide.html"
57+
var page_path = "";
58+
if (current_page.startsWith(base_url_absolute)) {
59+
page_path = current_page.substring(base_url_absolute.length);
60+
}
61+
62+
// construct the target URL with the same page path
63+
var target_url = target_href;
64+
if (page_path && page_path !== "" && page_path !== "index.html") {
65+
// ensure target_href ends with a slash before appending page path
66+
if (!target_url.endsWith("/")) {
67+
target_url = target_url + "/";
68+
}
69+
target_url = target_url + page_path;
70+
}
71+
72+
// preserve the anchor (hash) from the current page
73+
var current_hash = window.location.hash;
4174

4275
// Determine if this is a development version or an older release
4376
let warningMessage = "";
@@ -51,12 +84,35 @@ function maybeAddWarning() {
5184
"This documentation is for an <strong>older version</strong> that may be missing recent changes.<br>";
5285
}
5386

54-
warningMessage +=
55-
'<a href="' +
56-
href +
57-
'">Click here to go to the documentation for the latest stable release.</a>';
87+
// Create the link element with same-page navigation
88+
const link = document.createElement("a");
89+
link.href = target_url + current_hash;
90+
link.textContent =
91+
"Click here to go to the documentation for the latest stable release.";
92+
93+
// If we're trying to stay on the same page, verify it exists first
94+
if (page_path && page_path !== "" && page_path !== "index.html") {
95+
link.addEventListener("click", function (e) {
96+
e.preventDefault();
97+
// check if the target page exists, fallback to homepage if it doesn't
98+
fetch(target_url, { method: "HEAD" })
99+
.then(function (response) {
100+
if (response.ok) {
101+
window.location.href = target_url + current_hash;
102+
} else {
103+
// page doesn't exist in the target version, go to homepage
104+
window.location.href = target_href;
105+
}
106+
})
107+
.catch(function (error) {
108+
// network error or other failure - use homepage
109+
window.location.href = target_href;
110+
});
111+
});
112+
}
58113

59114
div.innerHTML = warningMessage;
115+
div.appendChild(link);
60116
div.appendChild(closer);
61117
document.body.appendChild(div);
62118
}

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.16.1 on <span class="colophon-date" title="Monday 24 November 2025 19:16">Monday 24 November 2025</span>. Using Julia version 1.12.2.</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.17.0 on <span class="colophon-date" title="Saturday 21 February 2026 17:52">Saturday 21 February 2026</span>. Using Julia version 1.12.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)