IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix definition lists inside api docs (#1084)

Browse Source 
* 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 https://github.com/readthedocs/sphinx_rtd_theme/pull/1084

Co-authored-by: Benjamin Bach <benjamin@overtag.dk>
This commit is contained in:
Aaron Carlisle 2022-08-27 16:04:31 -04:00 committed by GitHub
parent aeae4c1cf6
commit 15fdfa15dc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/demo/test_py_module/test.py
View File

@ -12,6 +12,20 @@ class Foo:
and etc, but those will *always* have the ``.descname`` or and etc, but those will *always* have the ``.descname`` or
``.descclassname`` class. ``.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 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````. the same style as anything else with ````this type of markup````.

2
sphinx_rtd_theme/static/css/theme.css
View File

File diff suppressed because one or more lines are too long

2
src/sass/_theme_rst.sass
View File

@ -452,7 +452,7 @@
font-size: 100% !important font-size: 100% !important
// In the html4 writer, parameters is a table. In html5 writer, parameters // In the html4 writer, parameters is a table. In html5 writer, parameters
// is a nested dl.field-list // 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 margin-bottom: $base-line-height / 4
border: none border: none
border-left: solid 3px hsl(0, 0%, 80%) border-left: solid 3px hsl(0, 0%, 80%)