CMakePP / CMinx

Generates API documentation for CMake functions and macros
https://cmakepp.github.io/CMinx/
Apache License 2.0
14 stars 5 forks source link

Add Exclude filters and other input options #97

Closed AutonomicPerfectionist closed 2 years ago

AutonomicPerfectionist commented 2 years ago

Is this pull request associated with an issue(s)? Fixes #66

Description This PR adds several new input options to control what files and directories are documented.

TODOs

Optional

codecov[bot] commented 2 years ago

Codecov Report

Merging #97 (b8d17e8) into master (c77a096) will increase coverage by 0.30%. The diff coverage is 96.25%.

@@            Coverage Diff             @@
##           master      #97      +/-   ##
==========================================
+ Coverage   95.68%   95.99%   +0.30%     
==========================================
  Files           6        6              
  Lines         765      799      +34     
==========================================
+ Hits          732      767      +35     
+ Misses         33       32       -1     
Flag Coverage Δ
unittests 95.99% <96.25%> (+0.30%) :arrow_up:

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

Impacted Files Coverage Δ
cminx/rstwriter.py 98.25% <92.85%> (ø)
cminx/__init__.py 93.19% <96.49%> (+1.74%) :arrow_up:
cminx/config.py 100.00% <100.00%> (ø)
cminx/documenter.py 99.11% <100.00%> (+0.88%) :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 46241e6...b8d17e8. Read the comment docs.

AutonomicPerfectionist commented 2 years ago

@ryanmrichard this one should be ready for review now. I decided against adding support for .cminxignore files as putting the exclusion filters in the configuration files should suffice. Let me know if you want me to add that

ryanmrichard commented 2 years ago

🚀 [bumpr] Bumped! New version:v0.1.1 Changes:v0.1.0...v0.1.1