executablebooks / sphinx-book-theme

A clean book theme for scientific explanations and documentation with Sphinx
https://sphinx-book-theme.readthedocs.io
BSD 3-Clause "New" or "Revised" License
439 stars 201 forks source link

Sidenotes and Marginnotes don't work #651

Open Gouvernathor opened 1 year ago

Gouvernathor commented 1 year ago

Following advice from this page. This is my conf.py (a bit of it anyway)

html_theme_options = dict(
    use_download_button=True,

    extra_navbar='',

    use_sidenotes=True,
)

This is the rst code

La devise de la République est "Liberté, Égalité, Fraternité".

Son principe est : gouvernement du peuple, par le peuple, pour le peuple[^mn1][^sn1].

[^mn1]: {-} This is a marginnote

[^sn1]: This is a sidenote

And this is the result image

welcome[bot] commented 1 year ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

AakashGfude commented 1 year ago

Hi @Gouvernathor , thanks for raising this. I double checked and does not seem to be a problem at my end. Can you tell us which version of sphinx-book-theme you are using? And if possible a link to your source repository? Thank you

aum7 commented 7 months ago

as of march 2024, i am experiencing the same problem - marginnotes and sidenotes are not working as expected

linux mint latest greatest firefox up-to-date

sphinx-book-theme version 1.1.0

conf.py html_theme_options = { ... 'use_sidenotes': True, }

inside my 'introduction.md' i have:

margin

output:

ff_sphinx_book_theme

the sphinx-book-theme site is generated from terminal with: $ sphinx-quickstart

thx for sharing, love the theme, toggle sidebar and dark/light theme are magnificent

have fun