Skip to content

[nrf fromtree] doc: extensions: kconfig: make location permalink opti… #3283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[nrf fromtree] doc: extensions: kconfig: make location permalink opti… #3283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions doc/_extensions/zephyr/kconfig/static/kconfig.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ function showProgress(message) {
* @returns {string} - The generated GitHub URL.
*/
function getGithubLink(path, line, mode = "blob", revision = "main") {
if (!zephyr_gh_base_url) {
return;
}

let url = [
zephyr_gh_base_url,
mode,
Expand Down Expand Up @@ -307,14 +311,18 @@ function renderKconfigEntry(entry) {
renderKconfigPropList(props, 'Choices', entry.choices, false);

/* symbol location with permalink */
const locationPermalink = document.createElement('a');
locationPermalink.href = getGithubLink(entry.filename, entry.linenr, "blob", zephyr_version);

const locationElement = document.createTextNode(`${entry.filename}:${entry.linenr}`);
locationElement.class = "pre";
locationPermalink.appendChild(locationElement);

renderKconfigPropLiteralElement(props, 'Location', locationPermalink);
let locationPermalink = getGithubLink(entry.filename, entry.linenr, "blob", zephyr_version);
if (locationPermalink) {
const locationPermalink = document.createElement('a');
locationPermalink.href = locationPermalink;
locationPermalink.appendChild(locationElement);
renderKconfigPropLiteralElement(props, 'Location', locationPermalink);
} else {
renderKconfigPropLiteralElement(props, 'Location', locationElement);
}

renderKconfigPropLiteral(props, 'Menu path', entry.menupath);

Expand Down