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
34 stars 18 forks source link

✨ NEW: add option to ignore existing files #84

Closed Thaza-Kun closed 1 year ago

Thaza-Kun commented 2 years ago

Added the -i / --ignore flag to ignore existing files when creating files from _toc.yml. Useful when some files have been written but many additional files have been defined in _toc.yml afterwards.

welcome[bot] commented 2 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 2 years ago

Codecov Report

Base: 91.02% // Head: 90.92% // Decreases project coverage by -0.09% :warning:

Coverage data is based on head (8ac71ff) compared to base (2462700). Patch coverage: 75.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #84 +/- ## ========================================== - Coverage 91.02% 90.92% -0.10% ========================================== Files 7 7 Lines 735 738 +3 ========================================== + Hits 669 671 +2 - Misses 66 67 +1 ``` | Flag | Coverage Δ | | |---|---|---| | pytests | `90.92% <75.00%> (-0.10%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/executablebooks/sphinx-external-toc/pull/84?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks) | Coverage Δ | | |---|---|---| | [sphinx\_external\_toc/tools.py](https://codecov.io/gh/executablebooks/sphinx-external-toc/pull/84/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#diff-c3BoaW54X2V4dGVybmFsX3RvYy90b29scy5weQ==) | `89.69% <50.00%> (-0.49%)` | :arrow_down: | | [sphinx\_external\_toc/cli.py](https://codecov.io/gh/executablebooks/sphinx-external-toc/pull/84/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#diff-c3BoaW54X2V4dGVybmFsX3RvYy9jbGkucHk=) | `89.28% <100.00%> (+0.19%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks)

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