Documentation

[LegrandNico]

Some examples of nice documentation in related packages:

• https://probml.github.io/dynamax/
• https://gpjax.readthedocs.io/en/latest/

• [ ] The GitHub action needs to be fixed.

README:

• [ ] A logo
• [ ] A paragraph describing the toolbox
• [ ] Figures of the premande HGFs
• [ ] A hello world example
• [ ] PkgEval badge
• [ ] Deps badge
• [ ] Version badge

User guide:

• [ ] Theory module with figures
• [ ] API examples
• [ ] Add the equations to the docstrings

Notebooks:

• [ ] Multilevel fitting

• [ ] Categorical HGF

• [ ] Kalman filter HGF

• [ ] Add to Documenter REPO