Skip to content

[clang-doc] Make sidebar sections collapsible #174531

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

Merged
evelez7 merged 1 commit into from
Jan 6, 2026
Merged

[clang-doc] Make sidebar sections collapsible #174531

Show file tree
Hide file tree
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
6 changes: 2 additions & 4 deletions clang-tools-extra/clang-doc/assets/clang-doc-mustache.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,17 +421,15 @@ body, html {
}

.sidebar ul li {
padding-right: 1rem;
padding-left: 2rem;
padding-left: 1rem;
padding-top: 0.25rem;
padding-bottom: 0.25rem;
}

.sidebar-section {
font-size:1.5rem;
font-weight: bold;
margin-bottom: 1rem;
padding: 3rem;
padding-left: 1rem;
}
.sidebar-section a {
color: var(--brand)
Expand Down
176 changes: 96 additions & 80 deletions clang-tools-extra/clang-doc/assets/class-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,115 +16,131 @@
<h2>{{TagType}} {{Name}}</h2>
<ul>
{{#HasPublicMembers}}
<li class="sidebar-section">
<a class="sidebar-item" href="#PublicMembers">Public Members</a>
</li>
<li>
<ul>
{{#PublicMembers}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/PublicMembers}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#PublicMembers">Public Members</a>
</summary>
<ul>
{{#PublicMembers}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/PublicMembers}}
</ul>
</details>
</li>
{{/HasPublicMembers}}
{{#ProtectedMembers}}
<li class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Protected Members</a>
</li>
<li>
<ul>
{{#Obj}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/Obj}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Protected Members</a>
</summary>
<ul>
{{#Obj}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/Obj}}
</ul>
</details>
</li>
{{/ProtectedMembers}}
{{#HasPublicFunctions}}
<li class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Public Method</a>
</li>
<li>
<ul>
{{#PublicFunctions}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/PublicFunctions}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#PublicMethods">Public Method</a>
</summary>
<ul>
{{#PublicFunctions}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/PublicFunctions}}
</ul>
</details>
</li>
{{/HasPublicFunctions}}
{{#ProtectedFunction}}
<li class="sidebar-section">
<a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
</li>
<li>
<ul>
{{#Obj}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
</li>
{{/Obj}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
</summary>
<ul>
{{#Obj}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
</li>
{{/Obj}}
</ul>
</details>
</li>
{{/ProtectedFunction}}
{{#HasEnums}}
<li class="sidebar-section">
<a class="sidebar-item" href="#Enums">Enums</a>
</li>
<li>
<ul>
{{#Enums}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Enums}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#Enums">Enums</a>
</summary>
<ul>
{{#Enums}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Enums}}
</ul>
</details>
</li>
{{/HasEnums}}
{{#HasTypedefs}}
<li class="sidebar-section">
<a class="sidebar-item" href="#Typedefs">Typedefs</a>
</li>
<li>
<ul>
{{#Typedefs}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Typedefs}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#Typedefs">Typedefs</a>
</summary>
<ul>
{{#Typedefs}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Typedefs}}
</ul>
</details>
</li>
{{/HasTypedefs}}
{{#HasRecords}}
<li class="sidebar-section">
<a class="sidebar-item" href="#Classes">Inner Classes</a>
</li>
<li>
<ul>
{{#Records}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Records}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#Classes">Inner Classes</a>
</summary>
<ul>
{{#Records}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
</li>
{{/Records}}
</ul>
</details>
</li>
{{/HasRecords}}
{{#HasFriends}}
<li class="sidebar-section">
<a class="sidebar-item" href="#Friends">Friends</a>
</li>
<li>
<ul>
{{#Friends}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Reference.USR}}">{{Reference.Name}}</a>
</li>
{{/Friends}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#Friends">Friends</a>
</summary>
<ul>
{{#Friends}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Reference.USR}}">{{Reference.Name}}</a>
</li>
{{/Friends}}
</ul>
</details>
</li>
{{/HasRecords}}
</ul>
Expand Down
22 changes: 12 additions & 10 deletions clang-tools-extra/clang-doc/assets/index-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,19 @@
<div class="sidebar">
<h2>{{ProjectName}}</h2>
<ul>
<li class="sidebar-section">
<a class="sidebar-item" href="#Namespaces">Namespaces</a>
</li>
<li>
<ul>
{{#Index}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/Index}}
</ul>
<details open>
<summary class="sidebar-section">
<a class="sidebar-item" href="#Namespaces">Namespaces</a>
</summary>
<ul>
{{#Index}}
<li class="sidebar-item-container">
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
</li>
{{/Index}}
</ul>
</details>
</li>
</ul>
</div>
Expand Down
Loading