Skip to content

Allow inline elements in sidenotes #612

@oyamauchi

Description

@oyamauchi

Context

When use_sidenotes is true and footnotes are converted to sidenotes, inline elements within the footnote content are stripped. When use_sidenotes is false, the inline elements show up as-is within the footnote. This means you can't even have bold or italics in sidenotes, which seems like a needless restriction.

Illustration:

with sidenotes on

with sidenotes off

Proposal

I'm not familiar with the details of Sphinx or Docutils, so I'm not sure how big of a task this is. As far as I can tell it's because of the call to astext() here:

https://github.com/executablebooks/sphinx-book-theme/blob/master/src/sphinx_book_theme/_transforms.py#L34

Tasks and updates

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions