👌 IMPROVE: Lhs menubar persistent

[DrDrij]

This PR adds a function call if a sidebar status has been set in localStorage. If the sidebar is open, it will stay open across pages and sessions (persistent). Fixes #131

A variable check has been added {% if persistent_sidebar is defined and persistent_sidebar is sameas true %}. If true the sidebar will be persistent. Config entry being: persistent_sidebar: true

[codecov[bot]]

Codecov Report

Merging #143 (7c1229e) into master (13d5f7a) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #143   +/-   ##
=======================================
  Coverage   72.29%   72.29%           
=======================================
  Files           2        2           
  Lines         231      231           
=======================================
  Hits          167      167           
  Misses         64       64           

Flag	Coverage Δ
pytests	72.29% <ø> (ø)

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

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 13d5f7a...7c1229e. Read the comment docs.

[DrDrij]

Need to add a config option to toggle the persistent sidebar.

[DrDrij]

Tested with variable but doesn't seem to be working. I think the Jinja logic looks ok. Have I missed something obvious @AakashGfude ?

[AakashGfude]

@DrDrij needed to add the variable in theme.conf.j2 and use theme_persistent_sidebar instead of persistent_sidebar as sphinx attaches theme_ for each HTML theme option variable.

Using it inside:

sphinx:
  config:
    html_theme_options:
      persistent_sidebar: true

[DrDrij]

Thanks @AakashGfude. I think this is ready — however the new variable needs to be added to lecture source config. What would be the best way to proceed/test build here @mmcky?

[mmcky]

hey @DrDrij we open a PR on lecture-python.myst and mark it as [TEST] <description> and update the environment.yml to replace quantecon-book-theme=0.2.x with

git+https://github.com/quantecon/quantecon-book-theme@lhs-menubar-sticky

[mmcky]

@DrDrij I linked a test case above for you to look at for the python.quantecon.org site.

@AakashGfude can you document (if it isn't already) how to regenerate the fixtures for @DrDrij -- I am guessing that is what is causing the ci issues?

[AakashGfude]

@mmcky the ci issue is caused by codecov which I mentioned yesterday. Getting back to it now.