DOC add dropdown header permalink #26872

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

Jump to bottom

Closed

greyisbetter wants to merge 6 commits into scikit-learn:main from greyisbetter:header-permalink

Contributor

greyisbetter commented Jul 20, 2023 •

edited

Loading

as discussed in #26617

It will inject an id="xxx" in the <details> tag
if url have .html#xxx then it will add open to <details id="xxx"> tag

example:

it will change from:

<details>
  <summary class="btn btn-light">
    <strong>Custom Kernels</strong>

to:

<details id="custom-kernels" open>
  <summary class="btn btn-light">
    <strong>Custom Kernels<a class="headerlink" href="#custom-kernels" title="Custom Kernels">¶</a></strong>

result:

cc @lucyleeow
cc @glemaitre @GaelVaroquaux


          [doc] dropdown header permalink

513eb41

github-actions bot added the Documentation label

github-actions bot commented Jul 20, 2023 •

edited

Loading

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: b8e7448. Link to the linter CI: here}


          Merge branch 'main' into header-permalink

9ab65eb

Member

lucyleeow commented Jul 21, 2023 •

edited

Loading

Would it be possible to enable getting a link to a the header via clicking next to it, e.g.: (you can't see the mouse in the screenshot but it's next to the header)

I am not very familiar with javascript, potentially @glemaitre or @thomasjpfan would have better guidance on the best approach? Potentially there is a Sphinx way to do this as suggested in: #26617 (comment) ?

Contributor Author

greyisbetter commented Jul 21, 2023

No it will not add that permalink icon to header but you go that section via https://scikit-learn.org/stable/modules/svm.html#custom-kernels

Member

lucyleeow commented Jul 21, 2023 •

edited

Loading

It's not so much the icon, but clicking on it will update the URL to append '#<section_name>', so you don't have to manually do this.

greyisbetter added 3 commits

July 21, 2023 08:35


          [doc] add permalink in header

1dfdbfa


          Merge remote-tracking branch 'upstream/main' into header-permalink

746dd3d


          Merge branch 'header-permalink' of https://github.com/greyisbetter/sc…

cf3674e

…ikit-learn into header-permalink

Contributor Author

greyisbetter commented Jul 21, 2023

It's not so much the icon, but clicking on it will update the URL to append '#<section_name>', so you don't have to manually do this.

Now it will work as expected


          [doc] show permalink in header

b8e7448

greyisbetter closed this

greyisbetter deleted the header-permalink branch

August 8, 2023 20:07

Member

lucyleeow commented Aug 14, 2023

Sorry I know this is closed now but would this be an acceptable solution to being able to easily get hyperlinks to headers where a dropdown has been added? Maybe @glemaitre @thomasjpfan ?

Member

glemaitre commented Aug 21, 2023

@lucyleeow I'm still in favor of having the feature that you requested. I did not get time to review PR lately but I should be back to business soonish.

If we can find an alternative solution to javascript, it would be better.

Member

glemaitre commented Aug 21, 2023

@lucyleeow Would you mind opening a proper issue to be sure that we track properly this feature request?

lucyleeow mentioned this pull request

DOC Add permalinks to dropdown headers #27127

Closed

glemaitre mentioned this pull request

DOC add permalink to summary of collapsed details section #27409

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels