py:property's stacking on a single line on larger screen widths. [replicated] #1301

ArachnidAbby · 2022-06-29T02:21:02Z

Problem

Multiple properties I defined in the docs are all stacking on a single line. I have no idea what could be causing it. Using | to force a new line just adds too much space to be reasonable.

Before you continue reading, thanks in advance for looking at my issue. Sorry if I just messed up my RST, I am fairly new to writing documentation in sphinx.

Reproducible Project

I think this should be the minimum needed to reproduce it. Just note that it doesn't happen on smaller screen widths.

.. py:class:: Entity(add_to_scene_entities=True, \
    name=str, visible=True, enabled=True, ignore=False, \
    eternal=False, ignore_puased=False, ignore_input=False, \
    parent=scene, model=None, color=color.white, texture=None, \
    double_sided=False, shader=Entity.default_shader, \
    collision=False, collider=None, scripts=List[], \
    animations=List[], origin=Vec3(0,0,0), position=Vec3(0,0,0), \
    rotation=Vec3(0,0,0),scale=Vec3(0,0,0), **kwargs)

    .. note::

        Many of the properties in this class also have setters.

        .. code-block:: python

            my_entity = Entity()                # create example Entity
            print(my_entity.flipped_faces)      # flipped_faces is a property
            my_entity.flipped_faces = True      # but also has a setter

    .. py:property:: world_position
        :type: Vec3

        Get individual coordinates with :code:`Entity.world_<x|y|z>`

    .. py:property:: x
        :type: float
        
        x position of the entity
    
    .. py:property:: y
        :type: float
        
        y position of the entity

    .. py:property:: z
        :type: float
        
        z position of the entity
    
    .. py:property:: X
        :type: int
        
        prefix for :code:`int(Entity.x)`
    
    .. py:property:: Y 
        :type: int

        prefix for :code:`int(Entity.y)`

    .. py:property:: Z 
        :type: int

        prefix for :code:`int(Entity.z)`

    .. py:property:: rotation
        :type: Vec3

        Get individual coordinates with :code:`Entity.rotation<x|y|z>`

    .. py:property:: quaternion

Error Logs/Results

No errors but here is a picture of what I see.

Expected Results

I expected each entry to be on a separate line regardless of the screen width.

Environment Info

Python Version: 3.10.5
Sphinx Version: 4.4.0
RTD Theme Version: 1.0.0

The text was updated successfully, but these errors were encountered:

KennethNielsen · 2022-07-06T08:55:55Z

I have the same issue. As a bonus info I can share that I tried to bisect the problem, by installing older versions of the theme, but as far back as 0.2.0 (which is the oldest I could install) I can replicate the faulty behavior. This suggests to me that the bug is brought on by a change elsewhere, which just now reveals a potential bug in the theme.

Environment info:

Python version: 3.10.4
Sphinx version: 4.5.0
RTD theme version: 1.0.0

EDIT: Addition environment information: I should probably also mention, that for my case the pages that showed this behavior were generated by autodoc from docstring written in the Google style and parsed with Napoleon.

ArachnidAbby · 2022-08-05T22:47:09Z

Thanks for replicating it, Is there anyway to avoid this behavior?

KennethNielsen · 2022-08-12T07:54:22Z

@spidertyler2005 I'm not associated with the project and I'm afraid I don't have the bandwidth to try and fix it, so for me unfortunately I will wait until someone from the project notices this bug. But, you can probably remove the "Needed: replication" label, that might help for visibility.

nocarryr · 2022-08-12T22:11:27Z

This might be the source of the issue:

sphinx_rtd_theme/src/sass/_theme_rst.sass

Lines 472 to 475 in bc73ad8

    
           .property 
        
             display: inline-block 
        
             padding-right: 8px 
        
             max-width: 100%

I'm seeing the same thing on my doc builds. If you use dev-tools to uncheck display: inline-block everything appears normal.

(It will be on the parent container <dl class="py property">)

nocarryr · 2022-08-18T21:04:23Z

@spidertyler2005 @KennethNielsen

Here's a gist that replicates the issue.

When built, the <dl class="py property"> tags are displayed as inline-block (as they do in the above screenshot).

If built with the last line of conf.py uncommented, the display property is overridden by css and they appear as expected.

(you'll have to do a make clean in between builds)

Note:
This is not a fix, it's a hack. Only meant to demonstrate the cause of the issue.

Unsure why this is necessary. There should never be a case where properties are displayed inline (if attributes and methods aren't) readthedocs/sphinx_rtd_theme#1301

johannes-mueller · 2023-02-06T09:39:57Z

Having the same issue. Is there a proper fix in sight?

workaround readthedocs/sphinx_rtd_theme#1301 Signed-off-by: Johannes Mueller <johannes.mueller4@de.bosch.com>

westonplatter · 2023-06-04T21:23:14Z

Ran into this today.

echoing the previous comment, "Is there a proper fix in sight?"

nocarryr · 2023-06-04T22:23:20Z

@westonplatter @johannes-mueller Can always just use the css override in my last comment.

If it's not going to be fixed by the maintainers, monkeyhacking is always a viable solution. (As of this comment, the style for ".property" still has display: inline-block; when it should just be display: block;

:py:`property` blocks get rendered on a single line instead of separate lines Fixes readthedocs#1301

workaround readthedocs/sphinx_rtd_theme#1301 Signed-off-by: Johannes Mueller <johannes.mueller4@de.bosch.com> Signed-off-by: Benjamin Maier <Benjamin.Maier2@de.bosch.com>

darkvertex · 2024-01-03T23:48:45Z

For anybody affected arriving here, a mini guide on monkeypatching this until the PR is hopefully merged someday:

Find your conf.py, ensure it has a html_static_path declaration, for example:
html_static_path = ['_static']
Add a new line or extend your existing html_css_files declaration:
html_css_files = ["custom.css"]
Go into this _static folder (or whatever you had it configured to.)
Dump in a custom.css file looking like so:

/*
Fix for horizontal stacking weirdness in the RTD theme with Python properties:
https://github.com/readthedocs/sphinx_rtd_theme/issues/1301
*/
.py.property {
  display: block !important;
}

make clean + make html and you should be looking good! ✨

whitequark · 2024-03-22T06:31:16Z

I'm hitting the same issue with sphinx-rtd-theme 2.0.0.

…eme#1301.

…appear on individual line as per readthedocs/sphinx_rtd_theme#1301

ArachnidAbby added Bug A bug Needed: replication Bug replication is required labels Jun 29, 2022

ArachnidAbby changed the title ~~py:property's stacking on a single line on larger screen widths.~~ py:property's stacking on a single line on larger screen widths. [replicated] Oct 15, 2022

johannes-mueller added a commit to boschresearch/pylife that referenced this issue Feb 6, 2023

Fix documentation layout issue of class properties

65ff998

workaround readthedocs/sphinx_rtd_theme#1301 Signed-off-by: Johannes Mueller <johannes.mueller4@de.bosch.com>

jposada202020 mentioned this issue Feb 12, 2023

Documentation stack properties adafruit/Adafruit_CircuitPython_Display_Shapes#60

Open

nocarryr added a commit to nocarryr/sphinx_rtd_theme that referenced this issue Jun 4, 2023

Set display: block on :py:property

88a673f

:py:`property` blocks get rendered on a single line instead of separate lines Fixes readthedocs#1301

nocarryr linked a pull request Jun 4, 2023 that will close this issue

Set display: block on :py:property #1483

Open

ordabayevy mentioned this issue Jan 11, 2024

Fix the docs cellarium-ai/cellarium-ml#109

Merged

whitequark added a commit to whitequark/amaranth that referenced this issue Mar 22, 2024

docs: upgrade sphinx-rtd-theme, work around readthedocs/sphinx_rtd_th…

81fcf76

…eme#1301.

github-merge-queue bot pushed a commit to amaranth-lang/amaranth that referenced this issue Mar 22, 2024

docs: upgrade sphinx-rtd-theme, work around readthedocs/sphinx_rtd_th…

72779b7

…eme#1301.

github-merge-queue bot pushed a commit to amaranth-lang/amaranth that referenced this issue Mar 22, 2024

docs: upgrade sphinx-rtd-theme, work around readthedocs/sphinx_rtd_th…

6b51252

…eme#1301.

abhilash-kumar-nair added a commit to modelon-community/impact-client-python that referenced this issue Apr 25, 2024

chore: reformat conf.py and add monkeypatch css to fix properties to …

a200177

…appear on individual line as per readthedocs/sphinx_rtd_theme#1301

abhilash-kumar-nair added a commit to modelon-community/impact-client-python that referenced this issue Apr 25, 2024

chore: reformat conf.py and add monkeypatch css to fix properties to …

0eeba40

…appear on individual line as per readthedocs/sphinx_rtd_theme#1301

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

py:property's stacking on a single line on larger screen widths. [replicated] #1301

py:property's stacking on a single line on larger screen widths. [replicated] #1301

ArachnidAbby commented Jun 29, 2022

KennethNielsen commented Jul 6, 2022 •

edited

ArachnidAbby commented Aug 5, 2022

KennethNielsen commented Aug 12, 2022 •

edited

nocarryr commented Aug 12, 2022

nocarryr commented Aug 18, 2022

johannes-mueller commented Feb 6, 2023

westonplatter commented Jun 4, 2023

nocarryr commented Jun 4, 2023

darkvertex commented Jan 3, 2024

whitequark commented Mar 22, 2024

py:property's stacking on a single line on larger screen widths. [replicated] #1301

py:property's stacking on a single line on larger screen widths. [replicated] #1301

Comments

ArachnidAbby commented Jun 29, 2022

Problem

Reproducible Project

Error Logs/Results

Expected Results

Environment Info

KennethNielsen commented Jul 6, 2022 • edited

ArachnidAbby commented Aug 5, 2022

KennethNielsen commented Aug 12, 2022 • edited

nocarryr commented Aug 12, 2022

nocarryr commented Aug 18, 2022

johannes-mueller commented Feb 6, 2023

westonplatter commented Jun 4, 2023

nocarryr commented Jun 4, 2023

darkvertex commented Jan 3, 2024

whitequark commented Mar 22, 2024

KennethNielsen commented Jul 6, 2022 •

edited

KennethNielsen commented Aug 12, 2022 •

edited