Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix definition lists inside api docs #1084

Merged
merged 9 commits into from
Aug 27, 2022
14 changes: 14 additions & 0 deletions docs/demo/test_py_module/test.py
Expand Up @@ -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````.

Expand Down
2 changes: 1 addition & 1 deletion sphinx_rtd_theme/static/css/theme.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion src/sass/_theme_rst.sass
Expand Up @@ -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%)
Expand Down