[general] remark_admonition + upgrade sphinx-proof and quantecon-book-theme #493

longye-tian · 2024-07-01T00:19:27Z

Dear John @jstac, Matt @mmcky

This pull request is for #442.

I reviewed all current QuantEcon intro lecture series. There are four lectures that contain remarks. Here is a summary:

geom_series.md
money_inflation.md
unpleasant.md
money_inflation_nonlinear.md

This pull request uses the geom_series.md lecture as an example to test the current admonition style.

Best ❤️
Longye

Update: 25th Sep 2024 This PR also updates to latest version of

quantecon-book-theme==0.7.2 and
sphinx_proof==0.2.0

to enable support for the minimal styling.

Dear John, This pull request is for #442. I use the geom_series.md lecture as an example to test the current admonition style. Best, Longye

netlify · 2024-07-01T00:20:09Z

✅ Deploy Preview for taupe-gaufre-c4e660 ready!

Name	Link
🔨 Latest commit	`c281cdb`
🔍 Latest deploy log	https://app.netlify.com/sites/taupe-gaufre-c4e660/deploys/66e3f14ad9bccf0008c9888f
😎 Deploy Preview	https://deploy-preview-493--taupe-gaufre-c4e660.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mmcky · 2024-07-01T00:24:31Z

thanks @longye-tian this will be a big help. We can work on updating sphinx-proof styles.

Are you familiar with any html/css? If you are we could link up and I can show you where to submit a PR with suggested style updates. But no worries if not.

longye-tian · 2024-07-01T00:26:12Z

thanks @longye-tian this will be a big help. We can work on updating sphinx-proof styles.

Are you familiar with any html/css? If you are we could link up and I can show you where to submit a PR with suggested style updates. But no worries if not.

Hi Matt,

No worries. I'm not familiar with the html and css.

Best,
Longye

github-actions · 2024-07-01T00:26:25Z

🚀 Deployed on https://66e3f341f0e44dd09b38ef1f--taupe-gaufre-c4e660.netlify.app

mmcky · 2024-07-01T00:33:03Z

thanks @longye-tian.

This is what the current styling is.

@jstac I propose that sphinx-proof adopts just a thin colour bar on the left hand side of the block.
Any thoughts or recommendations in colour choices to represent remark?

jstac · 2024-07-01T10:17:54Z

Any thoughts or recommendations in colour choices to represent remark

How about green similar to the numbers in

mmcky · 2024-07-02T05:39:46Z

@jstac is this closer to what you're thinking?

I will see if I can match the icon colour to the line colour as well.

I have setup executablebooks/sphinx-proof#106 to do a full review so that we can make all admonitions follow a similar minimal styling approach. I will need to define unique colours for all types of admonitions and style them all by a thin LHS line.

jstac · 2024-07-02T09:38:23Z

Looks great @mmcky , many thanks.

mmcky · 2024-07-11T00:49:35Z

will merge once ENH: Enable a minimal theme option for simpler admonition style executablebooks/sphinx-proof#106 is merged and released
update config to include proof_minimal_theme: True

mmcky · 2024-07-15T22:57:05Z

test improvements to sphinx-proof package

mmcky · 2024-07-15T23:17:00Z

@DrDrij can I get your advise here.

I have just updated sphinx-proof with new styling around the sphinx-proof admonitions, however it looks like quantecon-book-theme is overriding the title style with a background colour to show

instead of

Our theme has

  .admonition {
    font-size: 0.9rem;
    margin: 1.5rem auto;
    padding: 0 1rem 0.5rem 1rem;
    page-break-inside: avoid;
    box-shadow: 0 0.2rem 0.5rem rgba(0, 0, 0, 0.1),
      0 0 0.05rem rgba(0, 0, 0, 0.1);

    .admonition-title {
      position: relative;
      margin: 0 -1rem;
      padding: 0.25rem 2rem;
      font-weight: 700;
      background-color: #0072bc26;
    }
  }

and it makes sense for it to be the main "style" here but it is quite general.

Is the best solution here to update sphinx-proof to pre-pend an admonition name that is less generic so instead of using admonition-title we should use proof-admonition-title. I guess the downside of this is that it becomes harder for "themes" to override the style.

Otherwise, we could update our own theme to use a transparent background for admonition-title for consistency across the lecture.

DrDrij · 2024-07-18T10:46:21Z

@mmcky Hey Matt I notice that the admonition has the proof class <div class="proof remark admonition" id="remark-0">.

So we could style it specifically such as:

div.remark.proof {
   border-color: green;
   .admonition-title {
     background-color: transparent;
   }
 }

Not sure if I have answered your question correctly though. :)

mmcky · 2024-07-18T23:06:40Z

thanks @DrDrij so this is what we have in sphinx-proof

/*********************************************
* Remark *
*********************************************/
div.remark {
	border-color: var(--remark-border-color);
	background-color: none;
}

div.remark p.admonition-title {
	background-color: transparent;
}

but the title in this preview has a background colour that I think is coming from quantecon-book-theme?

maybe transaparent is allowing the quantecon-book-theme underneath?

DrDrij · 2024-07-19T04:15:29Z

Ah I see! Yes I made a mistake.

div.remark p.admonition-title {
	background-color: transparent;
}

Will override the CSS I wrote above. CSS weighting is sequentially - element, id, class, then order. So I am adjusting the CSS I wrote from:

div.remark.proof {
   border-color: green;
   .admonition-title {
     background-color: transparent;
   }
 }

To:

div.remark.proof {
   border-color: green;
   p.admonition-title {
     background-color: transparent;
   }
 }

This way it will override regardless of order loaded on client side since it has 1 more class of specificity.

mmcky · 2024-07-19T06:41:47Z

@DrDrij my target is to get no background colour -- as a minimal theme supplied by sphinx-proof. I used transparent so it would match the background colour of the page but it looks like the blue background is coming through from quantecon-book-theme instead.

mmcky · 2024-07-22T00:15:50Z

@DrDrij I made the suggested change in executablebooks/sphinx-proof#109 but it is still showing the blue background from quantecon-book-theme. Not sure how to override that style.

DrDrij · 2024-07-29T12:05:54Z

@mmcky I hope this is a reasonable request to make small changes to quantecon-book-theme and sphinx-proof to allow the styling of the admonition title background without having to force styles (using !important). I think it is best to do it properly.

executablebooks/sphinx-proof#111

QuantEcon/quantecon-book-theme#248

So what these changes involve is having each stylesheet (pydata, qe theme, and sphinx proof) all style the admonition title the same way. This means the ultimate background colour style will come from whichever stylesheet is loaded last in the chain. Which looks like proof.css.

mmcky · 2024-08-20T01:29:30Z

love your work @DrDrij

I will make new releases of:

quantecon-book-theme, and
sphinx-proof

then we will have minimal styles for all those admonitions such as remark.

This CSS tweak adjust the styling so that styles can be overriden without having to be forced. They will cascade from py_data -> quantecon_book_theme -> sphinx_proof. QuantEcon/lecture-python-intro#493

mmcky · 2024-09-11T22:45:46Z

thanks @longye-tian -- Would you mind to update the other lectures with remark admonitions and then we can merge this PR.

Add remark admonition for money_inflation.md

Add remark admonition to unpleasent.md

Add remark admonition for money_inflation_nonlinear.md

longye-tian · 2024-09-13T08:02:46Z

thanks @longye-tian -- Would you mind to update the other lectures with remark admonitions and then we can merge this PR.

Hi Matt @mmcky ,

I have updated the remark admonitions for these lectures.
I'll have a look on other lectures to see if there is any new lectures that need remark admonitions.

Best,
Longye

mmcky

thanks @longye-tian for your work on this.

[geom_series] remark_admonition

8853b70

Dear John, This pull request is for #442. I use the geom_series.md lecture as an example to test the current admonition style. Best, Longye

longye-tian requested a review from mmcky July 1, 2024 00:19

github-actions bot temporarily deployed to pull request July 1, 2024 00:26 Inactive

github-actions bot temporarily deployed to pull request July 1, 2024 00:27 Inactive

mmcky changed the title ~~[geom_series] remark_admonition~~ [sphinx-proof style review][geom_series] remark_admonition Jul 1, 2024

mmcky added the in-work label Jul 1, 2024

mmcky added ready on-hold and removed in-work labels Jul 15, 2024

TST: install main branch version of sphinx-proof

294ccfe

github-actions bot temporarily deployed to pull request July 15, 2024 23:05 Inactive

mmcky mentioned this pull request Jul 22, 2024

ENH: reconfigure css style executablebooks/sphinx-proof#109

Closed

2 tasks

test with new css definition

2054d7c

github-actions bot temporarily deployed to pull request July 22, 2024 00:14 Inactive

test the new css styling for remark

de7a451

github-actions bot temporarily deployed to pull request August 20, 2024 00:23 Inactive

test updated quantecon-book-theme

5b0d0d3

github-actions bot temporarily deployed to pull request August 20, 2024 00:51 Inactive

mmcky added 2 commits September 10, 2024 13:43

upgrade quantecon-book-theme==0.7.2

6acd7ac

update branch until released for sphinx-proof

c2f33f6

github-actions bot temporarily deployed to pull request September 10, 2024 03:58 Inactive

enable sphinx-proof==0.2.0

8b60a5a

github-actions bot temporarily deployed to pull request September 11, 2024 00:13 Inactive

mmcky and others added 2 commits September 11, 2024 10:32

update software for collab testing

aa6ba4a

Merge branch 'main' into geom_series_remark_admonition

6a48770

github-actions bot temporarily deployed to pull request September 11, 2024 00:58 Inactive

github-actions bot temporarily deployed to pull request September 11, 2024 00:59 Inactive

mmcky changed the title ~~[sphinx-proof style review][geom_series] remark_admonition~~ [geom_series] remark_admonition Sep 11, 2024

longye-tian added 3 commits September 13, 2024 17:58

remark_money_inflation

9b2c9b0

Add remark admonition for money_inflation.md

remark_unpleasent

daba2ce

Add remark admonition to unpleasent.md

remark_money_inflation_nonlinear

c281cdb

Add remark admonition for money_inflation_nonlinear.md

github-actions bot temporarily deployed to pull request September 13, 2024 08:07 Inactive

github-actions bot temporarily deployed to pull request September 13, 2024 08:09 Inactive

mmcky approved these changes Sep 25, 2024

View reviewed changes

mmcky changed the title ~~[geom_series] remark_admonition~~ [general] remark_admonition + upgrade sphinx-proof and quantecon-book-theme Sep 25, 2024

mmcky added ready and removed on-hold labels Sep 25, 2024

mmcky merged commit 905b7f9 into main Sep 25, 2024
7 checks passed

mmcky deleted the geom_series_remark_admonition branch September 25, 2024 04:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[general] remark_admonition + upgrade sphinx-proof and quantecon-book-theme #493

[general] remark_admonition + upgrade sphinx-proof and quantecon-book-theme #493

longye-tian commented Jul 1, 2024 •

edited by mmcky

Loading

netlify bot commented Jul 1, 2024 •

edited

Loading

mmcky commented Jul 1, 2024

longye-tian commented Jul 1, 2024

github-actions bot commented Jul 1, 2024 •

edited

Loading

mmcky commented Jul 1, 2024 •

edited

Loading

jstac commented Jul 1, 2024

mmcky commented Jul 2, 2024 •

edited

Loading

jstac commented Jul 2, 2024

mmcky commented Jul 11, 2024 •

edited

Loading

mmcky commented Jul 15, 2024 •

edited

Loading

mmcky commented Jul 15, 2024 •

edited

Loading

DrDrij commented Jul 18, 2024

mmcky commented Jul 18, 2024 •

edited

Loading

DrDrij commented Jul 19, 2024

mmcky commented Jul 19, 2024

mmcky commented Jul 22, 2024

DrDrij commented Jul 29, 2024

mmcky commented Aug 20, 2024 •

edited

Loading

mmcky commented Sep 11, 2024

longye-tian commented Sep 13, 2024

mmcky left a comment

[general] remark_admonition + upgrade sphinx-proof and quantecon-book-theme #493

[general] remark_admonition + upgrade sphinx-proof and quantecon-book-theme #493

Conversation

longye-tian commented Jul 1, 2024 • edited by mmcky Loading

netlify bot commented Jul 1, 2024 • edited Loading

✅ Deploy Preview for taupe-gaufre-c4e660 ready!

mmcky commented Jul 1, 2024

longye-tian commented Jul 1, 2024

github-actions bot commented Jul 1, 2024 • edited Loading

mmcky commented Jul 1, 2024 • edited Loading

jstac commented Jul 1, 2024

mmcky commented Jul 2, 2024 • edited Loading

jstac commented Jul 2, 2024

mmcky commented Jul 11, 2024 • edited Loading

mmcky commented Jul 15, 2024 • edited Loading

mmcky commented Jul 15, 2024 • edited Loading

DrDrij commented Jul 18, 2024

mmcky commented Jul 18, 2024 • edited Loading

DrDrij commented Jul 19, 2024

mmcky commented Jul 19, 2024

mmcky commented Jul 22, 2024

DrDrij commented Jul 29, 2024

mmcky commented Aug 20, 2024 • edited Loading

mmcky commented Sep 11, 2024

longye-tian commented Sep 13, 2024

mmcky left a comment

Choose a reason for hiding this comment

longye-tian commented Jul 1, 2024 •

edited by mmcky

Loading

netlify bot commented Jul 1, 2024 •

edited

Loading

github-actions bot commented Jul 1, 2024 •

edited

Loading

mmcky commented Jul 1, 2024 •

edited

Loading

mmcky commented Jul 2, 2024 •

edited

Loading

mmcky commented Jul 11, 2024 •

edited

Loading

mmcky commented Jul 15, 2024 •

edited

Loading

mmcky commented Jul 15, 2024 •

edited

Loading

mmcky commented Jul 18, 2024 •

edited

Loading

mmcky commented Aug 20, 2024 •

edited

Loading