Skip to content

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

Open
@ArachnidAbby

Description

@ArachnidAbby

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.

Screenshot_20220628_221448

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions