hpc-container-maker icon indicating copy to clipboard operation
hpc-container-maker copied to clipboard

Added purpose of file

Open robertlugg opened this issue 5 years ago • 1 comments

The first words I read were "arm_allinea_studio". This suggested that that is the topic of this document. Instead, add a very brief introduction to describe what this document is for. I've created some text that is OK but feel free to modify.

robertlugg avatar Nov 25 '19 17:11 robertlugg

Great point about missing a description of the document itself. This applies equally to the autogenerated primitives and misc_api documentation as well.

These files are auto generated from the code using pydocmd.

@robertlugg are you up for investigating how a static header can be added to dynamically generated documentation using pydocmd? The configuration file is pydocmd.yml at the top level of the repository.

samcmill avatar Nov 25 '19 17:11 samcmill