jupyter-book icon indicating copy to clipboard operation
jupyter-book copied to clipboard

Update config.py for sphinx_multitoc_numbering

Open whyjz opened this issue 3 years ago • 2 comments
trafficstars

Summary: This solves diagnosis #3 described here.

Explanation: conf.py generated by jupyter book config does not include a necessary extension sphinx_multitoc_numbering when use_multitoc_numbering is set to true. This causes inconsistency in the TOC numbering between a directly built Jupyter Book and another build using the generated conf.py. This PR fixes this by adding that extension in the config-generating function.

whyjz avatar Aug 06 '22 20:08 whyjz

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

welcome[bot] avatar Aug 06 '22 20:08 welcome[bot]

cc @mmcky - can you confirm that this is a correct improvement re: multitoc numbering behavior?

choldgraf avatar Aug 19 '22 11:08 choldgraf

pinging again @AakashGfude or @mmcky

choldgraf avatar Nov 15 '22 09:11 choldgraf

Thanks, @whyjz, this is looking good. Sorry for the late response. Will you be able to fix the tests? Else I can fix them and push them to your branch tomorrow.

AakashGfude avatar Apr 18 '23 14:04 AakashGfude

@AakashGfude Thank you for approving this! I am not sure how to fix those failed tests and need some help for sure. Thanks again in advance!

whyjz avatar Apr 18 '23 15:04 whyjz

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02 :tada:

Comparison is base (d16ca82) 91.48% compared to head (7b93ee9) 91.51%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1799      +/-   ##
==========================================
+ Coverage   91.48%   91.51%   +0.02%     
==========================================
  Files           7        7              
  Lines         693      695       +2     
==========================================
+ Hits          634      636       +2     
  Misses         59       59              
Flag Coverage Δ
pytests 91.51% <100.00%> (+0.02%) :arrow_up:

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

Impacted Files Coverage Δ
jupyter_book/config.py 94.52% <100.00%> (+0.05%) :arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Apr 25 '23 15:04 codecov[bot]

@AakashGfude I have fixed all the tests by adding sphinx_multitoc_numbering in the test output.

whyjz avatar Apr 25 '23 23:04 whyjz

Congrats on your first merged pull request in this project! :tada: congrats
Thank you for contributing, we are very proud of you! :heart:

welcome[bot] avatar Dec 05 '23 10:12 welcome[bot]

Thanks @whyjz, this is a great improvement!

agoose77 avatar Dec 05 '23 10:12 agoose77