search

executablebooks / sphinx-external-toc

A sphinx extension that allows the site-map to be defined in a single YAML file
https://sphinx-external-toc.readthedocs.io
MIT License
33 stars 18 forks source link

πŸ‘Œ IMPROVE: Detecting change in attributes of a toctree for triggering re-builds #48

Closed AakashGfude closed 3 years ago

AakashGfude commented 3 years ago

The following PR detects changes made to all attributes of a Toctree class including the options. And adds that particular subtree, including the parent docname to changed_docs for updation during the env-get-outdated event.

fixes https://github.com/executablebooks/sphinx-external-toc/issues/46

welcome[bot] commented 3 years ago

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:

codecov[bot] commented 3 years ago

Codecov Report

Merging #48 (965014e) into main (5f0cbdc) will increase coverage by 0.81%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #48      +/-   ##
==========================================
+ Coverage   90.46%   91.27%   +0.81%     
==========================================
  Files           6        6              
  Lines         650      665      +15     
==========================================
+ Hits          588      607      +19     
+ Misses         62       58       -4
Flag Coverage Ξ”
pytests 91.27% <100.00%> (+0.81%) :arrow_up:

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

Impacted Files Coverage Ξ”
sphinx_external_toc/api.py 95.29% <100.00%> (+3.08%) :arrow_up:
sphinx_external_toc/events.py 91.22% <100.00%> (+1.59%) :arrow_up:

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 5f0cbdc...965014e. Read the comment docs.

chrisjsewell commented 3 years ago

This is superseded by 96c80db, although I would note that I did not find any existing issue with retriggering builds when changing numbered. If you still find an issue with this, I would suggest making a PR with extra tests in tests/test_api.py