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 module documentation generation #137

Closed AutonomicPerfectionist closed 1 year ago

AutonomicPerfectionist commented 1 year ago

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

Description This PR adds the ability to include documentation for an entire CMake module. It takes advantage of the ability to add body content to the .. module: directive introduced in Sphinx 5.2.0

TODOs

Additional Context The CMinx-specific sections of the modified Antlr4 grammar needed to be moved due to the order of grammar rules being important. The end of the modified sections has been marked with a comment.

codecov[bot] commented 1 year ago

Codecov Report

Base: 97.01% // Head: 97.09% // Increases project coverage by +0.08% :tada:

Coverage data is based on head (be2275f) compared to base (3c82278). Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #137 +/- ## ========================================== + Coverage 97.01% 97.09% +0.08% ========================================== Files 8 8 Lines 904 931 +27 ========================================== + Hits 877 904 +27 Misses 27 27 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `97.09% <100.00%> (+0.08%)` | :arrow_up: | 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=CMakePP#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/CMakePP/CMinx/pull/137?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP) | Coverage Δ | | |---|---|---| | [src/cminx/aggregator.py](https://codecov.io/gh/CMakePP/CMinx/pull/137/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2FnZ3JlZ2F0b3IucHk=) | `95.27% <100.00%> (+0.21%)` | :arrow_up: | | [src/cminx/documentation\_types.py](https://codecov.io/gh/CMakePP/CMinx/pull/137/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2RvY3VtZW50YXRpb25fdHlwZXMucHk=) | `98.81% <100.00%> (+0.05%)` | :arrow_up: | | [src/cminx/documenter.py](https://codecov.io/gh/CMakePP/CMinx/pull/137/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CMakePP#diff-c3JjL2NtaW54L2RvY3VtZW50ZXIucHk=) | `100.00% <100.00%> (ø)` | | 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=CMakePP). 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=CMakePP)

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

AutonomicPerfectionist commented 1 year ago

@ryanmrichard I have no idea how this happened, but somehow this branch contains a few commits from the old JOSS paper branch. My master branch doesn't have them, and I don't recall merging with my local copy. I can either go through and manually revert each commit, I have a list of the ones that belong to the JOSS branch, or I can leave it as-is. What do you think I should do?

ryanmrichard commented 1 year ago

I'm on my phone so it's a pain to see what files will actually get merged. If the JOSS files are just in the history that's fine, but if they actually would get merged I would just make a new commit that deletes them.

AutonomicPerfectionist commented 1 year ago

@ryanmrichard JOSS files have been deleted, they're still in the history though. If everything succeeds this PR should be good for review