Fix definition lists inside api docs (#1084)

* Fix definition lists inside api docs This is similar to #1080 (and is needed to fix citations in the demo here) Fixes #1052 * Build Assets * Build Assets 2 * New build of theme.css and theme.js * Regenerate theme.css for #1084 Co-authored-by: Benjamin Bach <[email protected]>
readthedocs · Aug 27, 2022 · 15fdfa1 · 15fdfa1
1 parent aeae4c1
commit 15fdfa1
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/docs/demo/test_py_module/test.py b/docs/demo/test_py_module/test.py
@@ -12,6 +12,20 @@ class Foo:
     and etc, but those will *always* have the ``.descname`` or
     ``.descclassname`` class.
 
+    Term
+        It is also possible to include definitions inside docstrings.
+        They should be styled as a normal definition list.
+
+    :Field List:
+        It is also possible to include definitions inside docstrings.
+        They should be styled as a normal definition list.
+
+    .. [1] A footnote contains body elements, consistently indented by at
+       least 3 spaces.
+
+    .. [Citation] A citation contains body elements, consistently indented by at
+       least 3 spaces.
+
     Normal ``<tt>`` (like the <tt> I just wrote here) needs to be shown with
     the same style as anything else with ````this type of markup````.
 

diff --git a/sphinx_rtd_theme/static/css/theme.css b/sphinx_rtd_theme/static/css/theme.css
diff --git a/src/sass/_theme_rst.sass b/src/sass/_theme_rst.sass
@@ -452,7 +452,7 @@
         font-size: 100% !important
     // In the html4 writer, parameters is a table. In html5 writer, parameters
     // is a nested dl.field-list
-    dl:not(.field-list) > dt
+    dl:not(.option-list):not(.field-list):not(.footnote):not(.citation):not(.glossary):not(.simple) > dt
       margin-bottom: $base-line-height / 4
       border: none
       border-left: solid 3px hsl(0, 0%, 80%)