Feat: Enabled Interactive Table of Contents (TOC)

The TOC now dynamically updates as the user scrolls through the document. Signed-off-by: Adarsh <[email protected]>
p4lang · Jan 2, 2025 · bb4af1b · bb4af1b
1 parent 970b7c3
commit bb4af1b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/doxygen/doxygen.cfg b/docs/doxygen/doxygen.cfg
@@ -1439,6 +1439,7 @@ HTML_STYLESHEET        =
 HTML_EXTRA_STYLESHEET  = awesome_css/doxygen-awesome.css \
                          awesome_css/doxygen-awesome-sidebar-only.css \
                          awesome_css/doxygen-awesome-sidebar-only-darkmode-toggle.css \
+                         awesome_css/doxygen-awesome-interactive-toc.js \
                          ../assets/css/cards.css \
                          ../assets/css/flow.css \
                          ../assets/css/p4c_custom.css

diff --git a/docs/doxygen/p4c_header.html b/docs/doxygen/p4c_header.html
@@ -41,6 +41,12 @@
   DoxygenAwesomeDarkModeToggle.init()
 </script>
 
+<!-- Add interactive TOC -->
+<script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script>
+<script type="text/javascript">
+  DoxygenAwesomeInteractiveToc.init()
+</script>
+
 $treeview
 $search
 $mathjax