Updated docs (#246)

NERSC · Mar 31, 2022 · fb2f4c1 · fb2f4c1
1 parent 431912b
commit fb2f4c1
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -164,16 +164,13 @@ def copy_doxy_docs():
         print(f"cleaning macros from {file}...")
         for line in fileinput.input(file, inplace=True):
             for key in [
-                "TIMEMORY_NEVER_INSTRUMENT"
-                "TIMEMORY_EXTERN_VISIBLE",
+                "TIMEMORY_NEVER_INSTRUMENT" "TIMEMORY_EXTERN_VISIBLE",
                 "TIMEMORY_ALWAYS_INLINE",
                 "TIMEMORY_NODISCARD",
-                "TIMEMORY_NOINLINE"
-                "TIMEMORY_FLATTEN",
+                "TIMEMORY_NOINLINE" "TIMEMORY_FLATTEN",
                 "TIMEMORY_HIDDEN",
                 "TIMEMORY_NOCLONE",
-                "TIMEMORY_INLINE"
-                "TIMEMORY_HOT",
+                "TIMEMORY_INLINE" "TIMEMORY_HOT",
                 "TIMEMORY_LAMBDA",
                 "TIMEMORY_DEVICE_LAMBDA",
                 "TIMEMORY_DEVICE_FUCTION",
@@ -247,6 +244,23 @@ def copy_doxy_docs():
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
+html_theme_options = {
+    "analytics_id": "G-R0682G8FP1",
+    "analytics_anonymize_ip": False,
+    "logo_only": False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": True,
+    "vcs_pageview_mode": "",
+    # 'style_nav_header_background': 'white',
+    # Toc options
+    "collapse_navigation": True,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
+}
+
 # Breathe Configuration
 breathe_projects = {"timemory": "doxygen-xml"}
 breathe_default_project = "timemory"

diff --git a/docs/getting_started/integrating.md b/docs/getting_started/integrating.md
@@ -42,6 +42,7 @@ were not available when timemory was installed.
 | `timemory::timemory-compile-extra` | Extra optimization flags |
 | `timemory::timemory-compile-options` | Adds the standard set of compiler flags used by timemory |
 | `timemory::timemory-compile-timing` | Adds compiler flags which report compilation timing metrics |
+| `timemory::timemory-compiler-instrument-compile-options` | INTERFACE |
 | `timemory::timemory-compiler-instrument` | Provides library for compiler instrumentation |
 | `timemory::timemory-coverage` | Enables code-coverage flags |
 | `timemory::timemory-cpu-roofline` | Enables flags and libraries for proper CPU roofline generation |