docs: add the print page (#407)

kkedziak-splunk · web-flow · commit 20271a493881 · 2024-11-13T11:58:10.000+01:00
**Issue number:** ADDON-75611 ## Summary ### Changes > Please provide a summary of what's being changed Documentation changes: added print button that shows the whole documentation on one page. In order to enable this feature, first level headings needed to be added to files. ### User experience > Please describe what the user experience looks like before and after this change None ## Checklist If your change doesn't seem to apply, please leave them unchecked. * [x] I have performed a self-review of this change * [ ] Changes have been tested * [ ] Changes are documented * [x] PR title follows [conventional commit semantics](https://www.conventionalcommits.org/en/v1.0.0/)
diff --git a/docs/acl.md b/docs/acl.md
@@ -1 +1,3 @@
+# acl.py
+
 ::: solnlib.acl
diff --git a/docs/bulletin_rest_client.md b/docs/bulletin_rest_client.md
@@ -1 +1,3 @@
+# bulletin_rest_client.py
+
 ::: solnlib.bulletin_rest_client
diff --git a/docs/conf_manager.md b/docs/conf_manager.md
@@ -1 +1,3 @@
+# conf_manager.py
+
 ::: solnlib.conf_manager
diff --git a/docs/credentials.md b/docs/credentials.md
@@ -1 +1,3 @@
+# credentials.py
+
 ::: solnlib.credentials
diff --git a/docs/file_monitor.md b/docs/file_monitor.md
@@ -1 +1,3 @@
+# file_monitor.py
+
 ::: solnlib.file_monitor
diff --git a/docs/hec_config.md b/docs/hec_config.md
@@ -1 +1,3 @@
+# hec_config.py
+
 ::: solnlib.hec_config
diff --git a/docs/log.md b/docs/log.md
@@ -1 +1,3 @@
+# log.py
+
 ::: solnlib.log
diff --git a/docs/modular_input/checkpointer.md b/docs/modular_input/checkpointer.md
@@ -1 +1,3 @@
+# checkpointer.py
+
 ::: solnlib.modular_input.checkpointer
diff --git a/docs/modular_input/event.md b/docs/modular_input/event.md
@@ -1 +1,3 @@
+# event.py
+
 ::: solnlib.modular_input.event
diff --git a/docs/modular_input/event_writer.md b/docs/modular_input/event_writer.md
@@ -1 +1,3 @@
+# event_writer.py
+
 ::: solnlib.modular_input.event_writer
diff --git a/docs/modular_input/modular_input.md b/docs/modular_input/modular_input.md
@@ -1 +1,3 @@
+# modular_input.py
+
 ::: solnlib.modular_input.modular_input
diff --git a/docs/net_utils.md b/docs/net_utils.md
@@ -1 +1,3 @@
+# net_utils.py
+
 ::: solnlib.net_utils
diff --git a/docs/orphan_process_monitor.md b/docs/orphan_process_monitor.md
@@ -1 +1,3 @@
+# orphan_process_monitor.py
+
 ::: solnlib.orphan_process_monitor
diff --git a/docs/pattern.md b/docs/pattern.md
@@ -1 +1,3 @@
+# pattern.py
+
 ::: solnlib.pattern
diff --git a/docs/server_info.md b/docs/server_info.md
@@ -1 +1,3 @@
+# server_info.py
+
 ::: solnlib.server_info
diff --git a/docs/splunk_rest_client.md b/docs/splunk_rest_client.md
@@ -1 +1,3 @@
+# splunk_rest_client.py
+
 ::: solnlib.splunk_rest_client
diff --git a/docs/splunkenv.md b/docs/splunkenv.md
@@ -1 +1,3 @@
+# splunkenv.py
+
 ::: solnlib.splunkenv
diff --git a/docs/theme_overrides/partials/header.html b/docs/theme_overrides/partials/header.html
@@ -0,0 +1,104 @@
+<!-- Source:
+https://github.com/squidfunk/mkdocs-material/blob/master/src/templates/partials/header.html
+-->
+
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+  {% set class = class ~ " md-header--shadow md-header--lifted" %}
+{% elif "navigation.tabs" not in features %}
+  {% set class = class ~ " md-header--shadow" %}
+{% endif %}
+
+<!-- Header -->
+<header class="{{ class }}" data-md-component="header">
+  <nav
+    class="md-header__inner md-grid"
+    aria-label="{{ lang.t('header') }}"
+  >
+
+    <!-- Link to home -->
+    <a
+      href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"
+      title="{{ config.site_name | e }}"
+      class="md-header__button md-logo"
+      aria-label="{{ config.site_name }}"
+      data-md-component="logo"
+    >
+      {% include "partials/logo.html" %}
+    </a>
+
+    <!-- Button to open drawer -->
+    <label class="md-header__button md-icon" for="__drawer">
+      {% set icon = config.theme.icon.menu or "material/menu" %}
+      {% include ".icons/" ~ icon ~ ".svg" %}
+    </label>
+
+    <!-- Header title -->
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+            {{ config.site_name }}
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+            {% if page.meta and page.meta.title %}
+              {{ page.meta.title }}
+            {% else %}
+              {{ page.title }}
+            {% endif %}
+          </span>
+        </div>
+      </div>
+    </div>
+
+    {% if page.url_to_print_page %}
+      <a href="{{ page.url_to_print_page }}" title="Print Site" class="md-header__button md-icon">
+          {% include ".icons/material/printer.svg" %}
+      </a>
+    {% endif %}
+
+    <!-- Color palette toggle -->
+    {% if config.theme.palette %}
+      {% if not config.theme.palette is mapping %}
+        {% include "partials/palette.html" %}
+      {% endif %}
+    {% endif %}
+
+    <!-- User preference: color palette -->
+    {% if not config.theme.palette is mapping %}
+      {% include "partials/javascripts/palette.html" %}
+    {% endif %}
+
+    <!-- Site language selector -->
+    {% if config.extra.alternate %}
+      {% include "partials/alternate.html" %}
+    {% endif %}
+
+    <!-- Button to open search modal -->
+    {% if "material/search" in config.plugins %}
+      <label class="md-header__button md-icon" for="__search">
+        {% set icon = config.theme.icon.search or "material/magnify" %}
+        {% include ".icons/" ~ icon ~ ".svg" %}
+      </label>
+
+      <!-- Search interface -->
+      {% include "partials/search.html" %}
+    {% endif %}
+
+    <!-- Repository information -->
+    {% if config.repo_url %}
+      <div class="md-header__source">
+        {% include "partials/source.html" %}
+      </div>
+    {% endif %}
+  </nav>
+
+  <!-- Navigation tabs (sticky) -->
+  {% if "navigation.tabs.sticky" in features %}
+    {% if "navigation.tabs" in features %}
+      {% include "partials/tabs.html" %}
+    {% endif %}
+  {% endif %}
+</header>
diff --git a/docs/time_parser.md b/docs/time_parser.md
@@ -1 +1,3 @@
+# time_parser.py
+
 ::: solnlib.time_parser
diff --git a/docs/timer_queue.md b/docs/timer_queue.md
@@ -1 +1,3 @@
+# timer_queue.py
+
 ::: solnlib.timer_queue
diff --git a/docs/user_access.md b/docs/user_access.md
@@ -1 +1,3 @@
+# user_access.py
+
 ::: solnlib.user_access
diff --git a/docs/utils.md b/docs/utils.md
@@ -1 +1,3 @@
+# utils.py
+
 ::: solnlib.utils
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,9 +2,13 @@ site_name: Splunk Solutions SDK
 
 theme:
   name: "material"
+  custom_dir: docs/theme_overrides
   palette:
     primary: "black"
     accent: "orange"
+  features:
+    - content.code.copy
+    - navigation.indexes
 
 markdown_extensions:
   - toc:
@@ -15,12 +19,14 @@ markdown_extensions:
   - codehilite
 
 plugins:
-  - search
   - mkdocstrings:
       handlers:
         python:
           options:
             show_if_no_docstring: true
+  - autorefs
+  - search
+  - print-site  # should be at the end
 
 nav:
   - Home: index.md
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/solnlib/log.py b/solnlib/log.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# bulletin_rest_client.py`
	`2`	`+`
`1`	`3`	`::: solnlib.bulletin_rest_client`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# conf_manager.py`
	`2`	`+`
`1`	`3`	`::: solnlib.conf_manager`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# credentials.py`
	`2`	`+`
`1`	`3`	`::: solnlib.credentials`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# file_monitor.py`
	`2`	`+`
`1`	`3`	`::: solnlib.file_monitor`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# hec_config.py`
	`2`	`+`
`1`	`3`	`::: solnlib.hec_config`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# checkpointer.py`
	`2`	`+`
`1`	`3`	`::: solnlib.modular_input.checkpointer`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# event.py`
	`2`	`+`
`1`	`3`	`::: solnlib.modular_input.event`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+# event_writer.py`
	`2`	`+`
`1`	`3`	`::: solnlib.modular_input.event_writer`