API Documentation

[janvonrickenbach]

• API Documentation

  • General: Attributes are missing types. Types are there for init. #662
  • Lists all have Mapping[ValueT] as type #663
  • nodal_data and elemental data show type MeshDataT -> docs don't show what data is available. #665
  • Linked object definition: explain concept #666
    • explain concept

• Done:

  • Rework doc of enums (types). Skip inheritance.
  • All entities below model:
    • Links to parameter types don't work (e.g. enums).
  • Explain "store" concept
  • create_* functions on model don't show types and defaults are just shown as strings even if they are enums
  • Entities in tree are ordered like in ACP. Should be sorted alphabetically
  • Autocompletion does not work when creating entities (e.g. what are the arguments). Jump to definition also does not help.
  • Model
    • delete misses docs
    • mesh: Link to MeshData does not work
  • Material:
    • property sets are missing types
  • Element sets
    • Parameter docs missing
  • Material property sets
    • Missing docs and types
  • Field Variable:
    • Missing docs and types
  • Interpolation options:
    • Missing docs and types
  • Other data types:
    • Missing docs and types

[greschd]

Thanks @janvonrickenbach, agree with everything mentioned.

Regarding the package structure, we might consider adding one more level, for example:

- material_data
- layup_definition
- solid_model
- inspection (section cut, plots, ply book, ...)

The structure on the Model should then be the same.

EDIT: After discussion, we decided not to add this extra layer since it doesn't really improve discoverability. The groups would be unbalanced, layup_definition being by far the largest.

Additionally, I wonder if the enums.py should be split apart, and each enum moved to where it is used.
EDIT: this part we can do, but it's not critical since the canonical import name is anyway at the root level of the module.