Skip to content

DOC: Fix margin directive documentation#930

Merged
bsipocz merged 4 commits intoexecutablebooks:masterfrom
melissawm:fix-margin-docs
Mar 6, 2026
Merged

DOC: Fix margin directive documentation#930
bsipocz merged 4 commits intoexecutablebooks:masterfrom
melissawm:fix-margin-docs

Conversation

@melissawm
Copy link
Contributor

Closes #928

Addresses a recent change in Docutils 0.22+ which now flags as an error when a docutils.parsers.rst.directives.body.Sidebar element is nested under another element such as a topic or an admonition.

See also sphinx-doc/sphinx#14002 (comment) for context.

@bsipocz bsipocz added bug Something isn't working 🏷️ maintenance Related to maintaining and developing this theme labels Mar 6, 2026
@bsipocz
Copy link
Member

bsipocz commented Mar 6, 2026

My bad, some of the issues we see in CI here are already been fixed in #927. So I'll ignore the unrelated failures here and just review the content and fixes and will sort out any remaining issues as part of #927

bsipocz
bsipocz previously approved these changes Mar 6, 2026
Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @melissawm!

I have nitpick comments only that would make the rendered version look more consistent, but otherwise this now unblocks me to do the release!

Co-authored-by: Brigitta Sipőcz <b.sipocz@gmail.com>
@melissawm
Copy link
Contributor Author

Sorry didn't mean to dismiss your review! Is this a new github thing??

@bsipocz
Copy link
Member

bsipocz commented Mar 6, 2026

Sorry didn't mean to dismiss your review! Is this a new github thing??

Hmm, I'll look into the repo settings maybe something is weird there.

@bsipocz
Copy link
Member

bsipocz commented Mar 6, 2026

Yeap, it wasn't you but the settings; I unticked this box as I think it is more annoying than useful here.

Screenshot 2026-03-06 at 13 24 42

@bsipocz bsipocz merged commit 3437cf2 into executablebooks:master Mar 6, 2026
9 of 12 checks passed
@bsipocz
Copy link
Member

bsipocz commented Mar 6, 2026

Thank you again @melissawm for diving down into this rabbit hole!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working 🏷️ maintenance Related to maintaining and developing this theme

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: errors of margin and sidebar directives with newer docutils (0.22)

2 participants