[SYNPY-1423] update mkdocstrings dependency for 1.8.0 (#1145)

* upgrade to mkdocstring 1.8.0
Sage-Bionetworks · Nov 1, 2024 · 13c1c6e · 13c1c6e
1 parent b77c2b1
commit 13c1c6e
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 178 deletions.
diff --git a/docs/css/custom.css b/docs/css/custom.css
@@ -1,31 +1,3 @@
-[data-md-color-scheme="default"] {
-    --doc-symbol-attribute-fg-color: #953800;
-    --doc-symbol-function-fg-color: #8250df;
-    --doc-symbol-method-fg-color: #8250df;
-    --doc-symbol-class-fg-color: #0550ae;
-    --doc-symbol-module-fg-color: #5cad0f;
-
-    --doc-symbol-attribute-bg-color: #9538001a;
-    --doc-symbol-function-bg-color: #8250df1a;
-    --doc-symbol-method-bg-color: #8250df1a;
-    --doc-symbol-class-bg-color: #0550ae1a;
-    --doc-symbol-module-bg-color: #5cad0f1a;
-}
-
-[data-md-color-scheme="slate"] {
-    --doc-symbol-attribute-fg-color: #953800;
-    --doc-symbol-function-fg-color: #8250df;
-    --doc-symbol-method-fg-color: #8250df;
-    --doc-symbol-class-fg-color: #0550ae;
-    --doc-symbol-module-fg-color: #5cad0f;
-
-    --doc-symbol-attribute-bg-color: #9538001a;
-    --doc-symbol-function-bg-color: #8250df1a;
-    --doc-symbol-method-bg-color: #8250df1a;
-    --doc-symbol-class-bg-color: #0550ae1a;
-    --doc-symbol-module-bg-color: #5cad0f1a;
-}
-
 /* Indentation. */
 div.doc-contents {
     padding-left: 25px;
@@ -35,37 +7,3 @@ div.doc-contents {
 .md-typeset table tbody {
     font-size: .7rem
 }
-
-/* Adds icons in front of `class`, `attribute`, and `function` */
-div.doc-class .doc-heading:first-of-type::before {
-    color: var(--doc-symbol-class-fg-color);
-    background-color: var(--doc-symbol-class-bg-color);
-    border-radius: .1rem;
-    font-size: .85em;
-    padding: 0 .3em;
-    font-weight: bold;
-    content: "class";
-    margin-right: 5px;
-}
-
-div.doc-attribute .doc-heading:first-of-type::before {
-    color: var(--doc-symbol-attribute-fg-color);
-    background-color: var(--doc-symbol-attribute-bg-color);
-    border-radius: .1rem;
-    font-size: .85em;
-    padding: 0 .3em;
-    font-weight: bold;
-    content: "attr";
-    margin-right: 5px;
-}
-
-div.doc-function .doc-heading:first-of-type::before {
-    color: var(--doc-symbol-function-fg-color);
-    background-color: var(--doc-symbol-function-bg-color);
-    border-radius: .1rem;
-    font-size: .85em;
-    padding: 0 .3em;
-    font-weight: bold;
-    content: "func";
-    margin-right: 5px;
-}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -130,15 +130,24 @@ plugins:
       default_handler: python
       handlers:
         python:
+          import:
+          - https://docs.python.org/3/objects.inv
+          - https://python-markdown.github.io/objects.inv
           options:
             members_order: source
             show_if_no_docstring: False
             show_root_heading: True
             show_category_heading: True
+            show_symbol_type_heading: True
+            show_symbol_type_toc: True
             docstring_style: google
             docstring_section_style: spacy
             filters:
               - "!^_"
+            separate_signature: True
+            show_signature_annotations: True
+            signature_crossrefs: True
+
   - autorefs
   - termynal:
       prompt_literal_start:

diff --git a/setup.cfg b/setup.cfg
@@ -114,7 +114,7 @@ docs =
     mkdocs>=1.5.3
     mkdocs-material>=9.4.14
     mkdocstrings>=0.24.0
-    mkdocstrings-python>=1.7.5
+    mkdocstrings-python>=1.8.0
     termynal>=0.11.1
     mkdocs-open-in-new-tab~=1.0.3
     markdown-include~=0.8.1