Skip to content

Commit

Permalink
docs(configure): auto generate open urls (#3163)
Browse files Browse the repository at this point in the history
  • Loading branch information
ReenigneArcher authored Sep 11, 2024
1 parent 8098df6 commit c892026
Show file tree
Hide file tree
Showing 4 changed files with 163 additions and 105 deletions.
6 changes: 6 additions & 0 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,9 @@ INPUT = ../README.md \
contributing.md \
../third-party/doxyconfig/docs/source_code.md \
../src

# extra css
HTML_EXTRA_STYLESHEET += doc-styles.css

# extra js
HTML_EXTRA_FILES += configuration.js
37 changes: 37 additions & 0 deletions docs/configuration.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/**
* @brief Add a button to open the configuration option for each table
*/
document.addEventListener("DOMContentLoaded", function() {
const tables = document.querySelectorAll("table");
tables.forEach(table => {
if (table.className !== "doxtable") {
return;
}

let previousElement = table.previousElementSibling;
while (previousElement && previousElement.tagName !== "H2") {
previousElement = previousElement.previousElementSibling;
}
if (previousElement && previousElement.textContent) {
const sectionId = previousElement.textContent.trim().toLowerCase();
const newRow = document.createElement("tr");

const newCell = document.createElement("td");
newCell.setAttribute("colspan", "3");

const newCode = document.createElement("code");
newCode.className = "open-button";
newCode.setAttribute("onclick", `window.open('https://${document.getElementById('host-authority').value}/config/#${sectionId}', '_blank')`);
newCode.textContent = "Open";

newCell.appendChild(newCode);
newRow.appendChild(newCell);

// get the table body
const tbody = table.querySelector("tbody");

// Insert at the beginning of the table
tbody.insertBefore(newRow, tbody.firstChild);
}
});
});
Loading

0 comments on commit c892026

Please sign in to comment.