sphinx-book-theme icon indicating copy to clipboard operation
sphinx-book-theme copied to clipboard

Sidenotes / margin notes on List-Table content attached to table, not sidebar.

Open wrprice opened this issue 9 months ago • 0 comments

Describe the bug

context


.. list-table:: Example
   :widths: 25 75

   * - Left\ [#note]_
     - Right

.. [#note] This should appear in the sidebar, not inside the body to the
    right of the table -- and should not cause a horizontal scrollbar on
    the table itself.

expectation

I expect the footnote/sidenote to appear in the page sidebar.

bug

The sidenote expands the container holding the table, inside the main body area, which adds a horizontal scrollbar and effectively hides the sidenote unless it is scrolled into view because the table itself is still 100% width of the main body area.

problem This is a problem for people wanting to annotate table contents because the resulting annotations are hidden, hard to discover, and do not appear where expected.

Reproduce the bug

  1. Set html_theme_options = { "use_sidenotes": True } in conf.py
  2. Save above snippet as an RST file
  3. make html

List your environment

Name: sphinx-book-theme Version: 1.1.3 Python 3.13.2 GNU/Linux 5.15.167.4-microsoft-standard-WSL2

wrprice avatar Mar 22 '25 16:03 wrprice