Issue68

[ryanmrichard]

Is this pull request associated with an issue(s)? This PR fixes #68

Description As far as I can tell the only dependencies we actually need in requirements.txt are Antlr and confuse. AFAIK the version of Antlr has to actually be pinned because it appears that the files generated by Antlr know what version generated them. I'm not sure what versions of confuse we need.

On the Python front, I tested Python version 3.7 through 3.11. Python below 3.9 does not seem to work on account of the signature of CMinx's main function.

On the CMake front, CMake 3.14 or newer should work (we need FetchContent_MakeAvailable which was added in 3.14)

Specific things this PR does:

• Prune requirements.txt down to minimum dependencies
• Clean-up CMakeLists.txt (formatting)
• Adds docs/source/developer/repo_structure to detail how the directories/files of the repo are laid out
• Adds docs/source/developer/dependencies to explain the design decisions
• Makes ctest run Python unit tests (used to only test the CMake API)
• drop cminx_add_docs_target function (see #68 for more discussion on why we did this)

TODOs

• [x] work out CMake version range
• [x] work out Python version range

[ryanmrichard]

@AutonomicPerfectionist if you get a chance it would be very helpful if you could add the new dependencies to this PR (ideally add them with >= syntax to requirements.txt and updated the dependency documentation accordingly)

[codecov[bot]]

Codecov Report

Merging #95 (b66c054) into master (c77a096) will not change coverage. The diff coverage is n/a.

:exclamation: Current head b66c054 differs from pull request most recent head 1e03fe0. Consider uploading reports for the commit 1e03fe0 to get more accurate results

@@           Coverage Diff           @@
##           master      #95   +/-   ##
=======================================
  Coverage   95.68%   95.68%           
=======================================
  Files           6        6           
  Lines         765      765           
=======================================
  Hits          732      732           
  Misses         33       33           

Flag	Coverage Δ
unittests	95.68% <ø> (ø)

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

Impacted Files	Coverage Δ
cminx/config.py	100.00% <ø> (ø)

---

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 c77a096...1e03fe0. Read the comment docs.

[ryanmrichard]

@AutonomicPerfectionist I think this r2g. I'll work on CI coverage of dependencies in a new branch, as this one has gotten away from me.