QuantEcon / quantecon-book-theme

A Jupyter Book Theme for QuantEcon Book Style Projects
BSD 3-Clause "New" or "Revised" License
40 stars 20 forks source link

Refactoring quantecon-book-theme #223

Closed AakashGfude closed 11 months ago

AakashGfude commented 1 year ago

We are moving from setup.py to pyprojet.toml. Also having sphinx-theme-builder as the build system.

Fixes a bug for exercise icons now being rendered correctly

codecov[bot] commented 1 year ago

Codecov Report

Merging #223 (8e2265c) into master (918c0b6) will increase coverage by 1.93%. The diff coverage is 96.42%.

@@            Coverage Diff             @@
##           master     #223      +/-   ##
==========================================
+ Coverage   71.25%   73.18%   +1.93%     
==========================================
  Files           2        2              
  Lines         240      261      +21     
==========================================
+ Hits          171      191      +20     
- Misses         69       70       +1     
Flag Coverage Δ
pytests 73.18% <96.42%> (+1.93%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/quantecon_book_theme/launch.py 90.69% <ø> (ø)
src/quantecon_book_theme/__init__.py 64.57% <96.42%> (ø)

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

mmcky commented 1 year ago

Thanks @AakashGfude - It looks like this is building nicely and a good refactor of the code to bring it inline with EBP themes.

mmcky commented 1 year ago

@AakashGfude does this incorporate any updates to search or dark theme etc?

https://github.com/QuantEcon/lecture-python-intro/pull/265#pullrequestreview-1527594509

Just trying to keep track of this.

Thanks for your work on this refactor.

AakashGfude commented 1 year ago

Thanks @mmcky for checking this, I will verify the dark theme. I did get some changes in search locally, but in CI it seems to be the same unfortunately, which is quite puzzling. I will target it in another PR? I have time tomorrow. So, I will update the README, and verify the dark theme, work a bit on search.

AakashGfude commented 1 year ago

@mmcky It has updates on the dark theme. Contributing guide needs to be updated, README otherwise is okay.

AakashGfude commented 1 year ago

@mmcky, this PR should be mergeable now.

mmcky commented 12 months ago

thanks @AakashGfude -- exciting.

mmcky commented 11 months ago

@AakashGfude I have been testing this against lecture-python-intro and it is looking good. No visual differences that I can see with the current site 👍

For some embedded objects like sphinx-exercise there is a missing icon it seems. Is that theme related or sphinx-exercise issue?

Screenshot 2023-09-26 at 4 20 10 pm
AakashGfude commented 11 months ago

@mmcky thanks for testing it. Looks like a font awesome issue. I will have a look

AakashGfude commented 11 months ago

@mmcky it seems like the issue is also there in the current website: https://intro.quantecon.org/inequality.html

AakashGfude commented 11 months ago

@mmcky I have made a change in CSS here, using pydata's icon set.

Screen Shot 2023-09-27 at 11 41 52 pm

Given that the icon is still working in ebp documentation https://ebp-sphinx-exercise.readthedocs.io/en/latest/syntax.html . And most probably a version issue of fontawesome, I thought of correcting it in our theme, which is inheriting from pydata and using a newer fontawesome version.

mmcky commented 11 months ago

thanks @AakashGfude are you happy for me to merge this?

mmcky commented 11 months ago

Once this is merged would you be able to put a release PR together?

I think a major release number 0.6.0 would be good.

AakashGfude commented 11 months ago

Thanks @mmcky for reviewing this. Will cut a release.