Use CMakePP Org Documentation CI and Docs Cleanup

[zachcran]

Is this pull request associated with an issue(s)? This starts to chip away at #44.

Description Brings the documentation generation and deployment CI up to speed with the CMakePP org reusable workflow. Also adds API documentation via CMinx.

TODOs

• [x] Update documentation generation and deployment to use reusable workflow.
• [x] Add API documentation generation via CMinx.
  • This is currently not possible since the reusable workflow requires the CMake source code to be in the cmake/ directory. Therefore, this depends on #74 or the workflow being updated (CMakePP .github PR 20).
• [x] Update badges in README.rst.

[zachcran]

I switched this to use the existing API documentation generation in docs/source/conf.py and will just be generated with the rest of the documentation.

[AutonomicPerfectionist]

I switched this to use the existing API documentation generation in docs/source/conf.py and will just be generated with the rest of the documentation.

Should be fine, but the action will probably generate warnings, because it will still use CMinx to put generated documentation in the source folder but it won't be included. Probably not an issue though

[zachcran]

the action will probably generate warnings, because it will still use CMinx to put generated documentation in the source folder but it won't be included

I'm not sure if I understand what you mean here. Shouldn't the documentation be getting included through docs/source/developer/index.rst? I don't see any warnings on my local system, but I understand how different a local system and CI system can be sometimes.

[AutonomicPerfectionist]

I'm not sure if I understand what you mean here. Shouldn't the documentation be getting included through docs/source/developer/index.rst? I don't see any warnings on my local system, but I understand how different a local system and CI system can be sometimes.

Sorry, missed the conditional here: https://github.com/CMakePP/.github/blob/9ff017d38c8d1b41ce61ba0534fa8a84496d3117/.github/workflows/deploy_docs_master.yaml#L76

So if I understand correctly, since we no longer have api_docs_module set in the workflow, then that action will not run CMinx, correct?

[zachcran]

Correct! Since we don't provide api_docs_module anymore, CMinx is not run in the action (except when it is run in docs/source/conf.py).

[AutonomicPerfectionist]

Looks good to merge then

[github-actions[bot]]

🚀 [bumpr] Bumped! New version:v0.1.6 Changes:v0.1.5...v0.1.6