search

executablebooks / sphinx-design

A sphinx extension for designing beautiful, screen-size responsive web components.
https://sphinx-design.readthedocs.io/en/furo-theme/
MIT License
198 stars 61 forks source link

Aside boxes #97

Open Julian opened 2 years ago

Julian commented 2 years ago

Context

Hi. Not sure if component feature requests are welcome, obviously feel free to close if not, but I just found this package when trying to avoid cobbling together a sphinx directive + CSS I repeatedly use in sphinx docs, which is a sort of "aside" text box.

Specifically some enclosed text box which is floated (right, say), has the main text flow around it, and contains some aside remark rather than the full width that one gets from an admonition.

Thanks for any consideration, and for writing the package!

Proposal

No response

Tasks and updates

No response

welcome[bot] commented 2 years 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:

chrisjsewell commented 2 years ago

Heya, well I guess you could currently achieve this with grids, in some fashion.

But in general, the interplay between this extension and theme extensions is a little bit "grey" here. For example, with sphinx-book-theme you can use margin blocks and sidenotes: https://sphinx-book-theme.readthedocs.io/en/latest/content-blocks.html#block-margin-content-with-the-margin-directive. I feel this is maybe a nicer way to do this, but only something achievable if you have a "full control" of the HTML template

Julian commented 2 years ago

Heya, well I guess you could currently achieve this with grids, in some fashion.

Hello! Interesting. I saw grids in the docs, but for some reason came away thinking I could only use them for a full-width block of content, not if I wanted just what I see sphinx-book-theme calls a sidebar which indeed is exactly what I want.

I happen to be using furo for most of my projects so if as you say this is a grey area and hairy to make cross-theme that certainly is understandable.