Styling margin directive from sphinx-book-theme

[AakashGfude]

Desktop :

Mobile:

TODO:

• [x] interaction with right sidebar toc
• [x] Add docs

fixes https://github.com/QuantEcon/quantecon-book-theme/issues/229

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (e65778b) 73.18% compared to head (8e898ab) 73.07%. Report is 2 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #238 +/- ## ========================================== - Coverage 73.18% 73.07% -0.11% ========================================== Files 2 2 Lines 261 260 -1 ========================================== - Hits 191 190 -1 Misses 70 70 ``` | [Flag](https://app.codecov.io/gh/QuantEcon/quantecon-book-theme/pull/238/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=QuantEcon) | Coverage Δ | | |---|---|---| | [pytests](https://app.codecov.io/gh/QuantEcon/quantecon-book-theme/pull/238/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=QuantEcon) | `73.07% <100.00%> (-0.11%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=QuantEcon#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[mmcky]

thanks @AakashGfude this is looking nice.

does the margin note need to have a title (or is that optional?)

[AakashGfude]

@mmcky, that is optional, but it currently has a fixed title space. The style coming from Pydata:

Unlike that in sbt:

I will fix it.

[AakashGfude]

@mmcky I have done this here, for margins without title:

[mmcky]

thanks @AakashGfude happy for your to go ahead and merge when you're ready.

can you add that this is supported to the docs as well

[AakashGfude]

@mmcky, this has been added to the docs. What do you think?

[AakashGfude]

@mmcky I have also cleaned the design a bit, mimicking the sphinx-book-theme now:

What do you think?

There are a few additional changes/additions for margin content:

• [x] handling the tag figclass: margin-caption for making figure captions behave as margins.

• [x] making margins responsive (handling for phone screens).

  

• [x] styling notes code blocks for margins.

[mmcky]

thanks @AakashGfude this is looking nice -- much better.

Last question -- what happens on the latex side of things for margin notes?

[mmcky]

@AakashGfude I am going to merge this just curious re: latex side if we start to use them.

Last question -- what happens on the latex side of things for margin notes?

[AakashGfude]

@mmcky, I have this planned this week—the latex thing. The latex build was failing in my system, so I could not test it immediately. I will correct that first.

[AakashGfude]

@mmcky for latex build, the margin is looking like this:-

What do you think is the best UI for margins? Given they can't stick to the sides like websites. Let me check jupyter book as well

[mmcky]

thanks @AakashGfude if they don't break LaTeX builds that is great news.

That means we can deploy this theme update without potential lack of support on the pdf side causing build failures.

Of course it would be good to add support for it over time to sphinx-jupyterbook-latex

Perhaps next steps are:

1. Open an Issue in sphinx-jupyterbook-latex to make improvements to margin object support in pdf
2. I think this is probably the most common practice in terms of TeX support https://www.overleaf.com/learn/latex/Margin_notes

[AakashGfude]

That sounds excellent @mmcky. Thanks, I will do that.