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 CMake Interface, autogen CMake docs #28

Closed AutonomicPerfectionist closed 3 years ago

AutonomicPerfectionist commented 3 years ago

This pull request adds a cmake interface to CMinx, allowing easy documentation generation during the configure and build stages. An example of this is seen in CMakeLists.txt, where we now autogen CMake RST docs during the configure phase and add a build target to build docs, accessible in the build phase.

codecov[bot] commented 3 years ago

Codecov Report

Merging #28 (6533206) into master (09701b0) will decrease coverage by 0.07%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #28      +/-   ##
==========================================
- Coverage   86.97%   86.90%   -0.08%     
==========================================
  Files           8        8              
  Lines         860      863       +3     
==========================================
+ Hits          748      750       +2     
- Misses        112      113       +1     
Impacted Files Coverage Δ
cminx/__init__.py 89.70% <100.00%> (+0.15%) :arrow_up:
cminx/parser/CMakeParser.py 68.69% <0.00%> (-0.32%) :arrow_down:
cminx/parser/aggregator.py 100.00% <0.00%> (ø)
cminx/rstwriter.py 98.20% <0.00%> (+<0.01%) :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 09701b0...6533206. Read the comment docs.

ryanmrichard commented 3 years ago

Is this ready to merge then?

AutonomicPerfectionist commented 3 years ago

Yes, it should be ready to merge now.