GMXAPI layout / grouping in development docs "modules" page
There are several strange aspects of the layout of
This is multiple issues (or multiple changes), that will become clearer when a resolution is attempted.
- user doc lists several of the "Modules for simulation functionality" but without that grouping. Either the modules weren't intended to be visible at that level or the module group is defined in too narrow a scope.
gmx::compatis listed in the user-level doc as "Module_compat" without description. In library and full docs, it appears twice with slightly different entries.
- "MD Restraints" is the sole sub-item of "Public API," which seems inconsistent with other categorization. Maybe move to the (missing) user-level section for "Modules for simulation functionality"?
#1 Updated by Mark Abraham about 2 years ago
User doc is uncurated, and will have to go away when we have our new API, so I can't encourage anyone to spend time there.
compat probably started as library only, but the existing poor design means it's probably now in installed headers that again will go away
MD Restraints is the only thing currently there that might survive in the new API, so characterizing it separately seems OK to me.
Basically, there's no time or reason to do a good job of these aspects - let's focus on the future.