Documentation formatting
-
In getting started: Rename hands-on to getting started and adapt subsection titles. -
Add overview chart for modules -
Add page-toc for classes in API -
Reduce size of explore flow field notebook by clearing the output -
Add application examples in the API reference -
Move __init__ parameters to the class docstring as the sphinx autodoc uses it to generate the constructor signature and the special __init__ is not explicitly included by intent -
Add images and example code to documentation where it increases the understandibility (e.g. Refilling Dataset) -
Move all contrast modules to separate files -
Changes sphinx panels to sphinx cards due to future deprecation -
Missing example usage for newer trajectory modules -
Missing doc-string ins diffusion-Taylor module
Bugs:
-
GeneralBlochOperator -> trajectory module argument weird indent -
TimeVarying tajectory -> example usage emtpy -
On Trajectory page all modules are duplicated -
On Dataset page all modules are duplicated -
Parameter in RefillingDataset.__call__ contains bold font -> probably un-escaped * -
bloch submodules empy call docstring -
Lookuptable linear interpolation docstring in incorrect -
BaseSampling docstring unexpected linebreak -
Contrast modules unexpected linebreaks -
Wrong package Name in gering started card -
Typo in math for POD module API and notebook -
missing docstring for n_modes and poly_order in POD module
Edited by Jonathan Weine