0

Hi I have issue with Sphinx where my description text seems to overlap with the attributes and methods table. This happens when I add an indentation (Literal Block) to the class description. If my class description does not have any indentation, then the overlap issue does not happen. My expected behavior in the doc page is as follow:

Description, Attributes Table, Methods Table

but because of the indentation (literal block) I would get Description Attributes Table, Methods Table, Description (continued).

I've attached a screenshot for an example. Here in the screenshot, the list items are supposed to appear before the Attributes table:

  • CHECK
  • RETURN_HTTP_RESPONSE

enter image description here

Thanks for the help.

Edit: The corresponding .rst file looks like so:

ProtectionRule
==============

.. currentmodule:: oci.waf.models

.. autoclass:: ProtectionRule
    :show-inheritance:
    :special-members: __init__
    :members:
    :undoc-members:
    :inherited-members:
mzjn
  • 48,958
  • 13
  • 128
  • 248
waru waruwaru
  • 9
  • 2
  • Please include the reStructuredText source that generates the HTML. – Steve Piercy Mar 08 '22 at 08:08
  • In this bug report, you say that the Sphinx version is 1.8.3, which is quite old. Have you tried the latest version? https://github.com/sphinx-doc/sphinx/issues/10246 – mzjn Mar 08 '22 at 12:58
  • I've added the corresponding .rst file. I have no tried a newer version of sphinx but that is something I can look into. – waru waruwaru Mar 09 '22 at 23:11
  • This appears to be about https://github.com/oracle/oci-python-sdk (source code for the class: https://github.com/oracle/oci-python-sdk/blob/master/src/oci/waf/models/protection_rule.py). – mzjn Mar 10 '22 at 06:48
  • There is no literal block in the linked class definition, but the bullet list is malformed in the output (because of a missing blank line): https://docs.oracle.com/en-us/iaas/tools/python/2.60.0/api/waf/models/oci.waf.models.ProtectionRule.html – mzjn Mar 12 '22 at 08:08
  • I've tried adding a blank line and that works if I only have a bullet list but if I have more paragraphs followed by additional bullet lists after, this overlapping will still occur. – waru waruwaru Mar 16 '22 at 19:42
  • Please provide a [mcve]. – mzjn Mar 18 '22 at 08:17

0 Answers0