jupyter-book
jupyter-book copied to clipboard
Update config.py for sphinx_multitoc_numbering
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.
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:
cc @mmcky - can you confirm that this is a correct improvement re: multitoc numbering behavior?
pinging again @AakashGfude or @mmcky
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 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!
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.
@AakashGfude I have fixed all the tests by adding sphinx_multitoc_numbering in the test output.
Congrats on your first merged pull request in this project! :tada:
Thank you for contributing, we are very proud of you! :heart:
Thanks @whyjz, this is a great improvement!