Add Autogenerated API Reference
Problem
Pyneapple's API documentation is manually written. As the codebase grows, maintaining consistency becomes difficult.
Proposed Solution
Use mkdocstrings to automatically generate API docs from docstrings.
Why mkdocstrings:
- Integrates with existing mkdocs
- Markdown output (matches current docs style)
- Auto-updates from docstrings on each build
API Surface to Document
- Models: MonoExpModel, BiExpModel, TriExpModel, NNLSModel
- Solvers: CurveFitSolver, ConstrainedCurveFitSolver, NNLSSolver
- Fitters: PixelWiseFitter, SegmentedFitter, SegmentationWiseFitter, IDEALFitter
- I/O: load_dwi_nifti, save_parameter_map, load_config, etc.
- Utilities: validation functions, spectrum tools, plotting
Implementation
pip install mkdocstrings mkdocstrings-python
Then add to mkdocs.yml:
plugins:
- mkdocstrings:
handlers:
python:
options:
show_root_heading: true
Add Autogenerated API Reference
Problem
Pyneapple's API documentation is manually written. As the codebase grows, maintaining consistency becomes difficult.
Proposed Solution
Use mkdocstrings to automatically generate API docs from docstrings.
Why mkdocstrings:
API Surface to Document
Implementation
pip install mkdocstrings mkdocstrings-python Then add to mkdocs.yml: plugins: - mkdocstrings: handlers: python: options: show_root_heading: true