Check in material theme for docs

slaclab · May 27, 2022 · ee882f4 · ee882f4
1 parent 9c2603a
commit ee882f4
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -1 +1,3 @@
-mkdocstrings
+mkdocks
+mkdocstrings
+mkdocs-material
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -16,6 +16,8 @@ nav:
     - Server: Server.md
     - EPICS: EPICS.md
 plugins:
+  - search:
+      separator: '[\s\-\.]'
   - mkdocstrings:
       default_handler: python
       handlers:
@@ -27,3 +29,19 @@ plugins:
               - "^__init__$"  # but always include __init__ modules and methods
           rendering:
             show_source: true
+            show_root_toc_entry: false
+            show_root_heading: true
+            show_if_no_docstring: false
+            show_signature_annotations: true
+            separate_signature: true
+            merge_init_into_class: true
+            show_submodules: true
+            heading_level: 2
+
+theme:
+  name: material
+  features:
+    - toc.integrate
+    - toc.follow
+    - navigation.top
+    - navigation.tabs