mirror of
https://github.com/borgbackup/borg.git
synced 2026-06-12 18:30:18 -04:00
a5ef482ca8
Enable the pdf output format on Read the Docs (the LaTeX build config already existed in docs/conf.py) and add a "Downloads" line to the left sidebar that links the offline formats (PDF, HTML zip, ePub). The links are populated from the Read the Docs addons data, reusing the same mechanism as the version selector, so they are version-correct and hidden when unavailable. The line is left-aligned with the boxes above and the table of contents below, with separators above and below it. Also drop the stale 'resources' entry from latex_appendices (the page was removed in #2088); it broke the now-enabled PDF build with a doctree KeyError. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
27 lines
1.1 KiB
HTML
27 lines
1.1 KiB
HTML
<p class="borg-downloads" id="borg-downloads" style="display:none;">Downloads: <span id="borg-downloads-list"></span></p>
|
|
<script type="text/javascript">
|
|
// Populate offline download links (PDF, HTMLzip, ...) on a single line using ReadTheDocs data if available.
|
|
function borgInitDownloads(data) {
|
|
var downloads = data && data.versions && data.versions.current && data.versions.current.downloads;
|
|
if (!downloads) return;
|
|
var labels = {pdf: "PDF", htmlzip: "HTML", epub: "ePub"};
|
|
var span = document.getElementById("borg-downloads-list");
|
|
if (!span) return;
|
|
var first = true;
|
|
Object.keys(downloads).forEach(function(fmt) {
|
|
var url = downloads[fmt];
|
|
if (!url) return;
|
|
if (!first) span.appendChild(document.createTextNode(" | "));
|
|
var a = document.createElement("a");
|
|
a.href = url;
|
|
a.textContent = labels[fmt] || fmt;
|
|
span.appendChild(a);
|
|
first = false;
|
|
});
|
|
if (!first) document.getElementById("borg-downloads").style.display = "";
|
|
}
|
|
|
|
document.addEventListener("readthedocs-addons-data-ready", function(event) {
|
|
borgInitDownloads(event.detail.data());
|
|
});
|
|
</script>
|