AML Doc cleanup

[iskra-anl]

In GitLab by @perarnau on May 6, 2020, 10:20

Need to merge the tutorial pages with the rest of the documentation. The plan is to basically take the text of the tutorial, and make it the entire doc, adding and fixing stuff in places.

The overall structure of the documentation would then be:

• Building Block
  • Overview/Definition
  • Generic Operations
  • Implementations description
  • Examples from the tutorial

One section like this for each building block, plus a couple of pages for installation, hello world, and a good overview of the generic/implementation system for building blocks.

Most of the code/text is already there, we just need to clean it up, and merge the entire thing in master.

TODO:

• [ ] Spack install in overview
• [ ] Restructure a bit the area section to match the others
• [ ] remove? scratchpad until further notice
• [ ] Fixup FORTRAN/C doc in places
• [ ] merge structure of pages one by one
• [ ] aml_version doc missing from overview
• [ ] fix @param for [in,out] across the doc (its param[in], not param name[in])
• [ ] fix _DECL macros still mentioned in README

Also, we should be careful not to use the doxygen groups directly if we can, and reference individual functions/variables, it would look better.

[iskra-anl]

In GitLab by @perarnau on May 6, 2020, 10:24

changed the description

[iskra-anl]

In GitLab by @perarnau on May 6, 2020, 10:29

changed the description

[iskra-anl]

In GitLab by @perarnau on Aug 4, 2020, 11:55

changed the description

[iskra-anl]

In GitLab by @perarnau on Aug 7, 2020, 15:09

changed the description

[iskra-anl]

In GitLab by @perarnau on Aug 7, 2020, 15:09

changed the description

[iskra-anl]

In GitLab by @perarnau on Aug 18, 2020, 10:06

changed the description

[iskra-anl]

In GitLab by @perarnau on Aug 19, 2020, 14:37

Related to !134