feat: Use sections titles in SpaCy-styled docstrings

mkdocstrings · Apr 30, 2022 · fe16b54 · fe16b54
1 parent 0822ff9
commit fe16b54
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html
@@ -49,7 +49,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>ATTRIBUTE</b></th>
+        <th><b>{{ (section.title or "ATTRIBUTE").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html
@@ -49,7 +49,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>PARAMETER</b></th>
+        <th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
@@ -59,7 +59,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>PARAMETER</b></th>
+        <th><b>{{ (section.title or "PARAMETER").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html
@@ -47,7 +47,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>RAISES</b></th>
+        <th><b>{{ (section.title or "RAISES").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html
@@ -52,7 +52,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>RECEIVES</b></th>
+        <th><b>{{ (section.title or "RECEIVES").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html
@@ -52,7 +52,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>RETURNS</b></th>
+        <th><b>{{ (section.title or "RETURNS").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html
@@ -47,7 +47,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>WARNS</b></th>
+        <th><b>{{ (section.title or "WARNS").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html b/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html
@@ -52,7 +52,7 @@
   <table>
     <thead>
       <tr>
-        <th><b>YIELDS</b></th>
+        <th><b>{{ (section.title or "YIELDS").rstrip(":").upper() }}</b></th>
         <th><b>DESCRIPTION</b></th>
       </tr>
     </thead>