Skip to content

Add settings and base classes to API reference #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henrikjacobsenfys merged 1 commit into from
May 19, 2026
+12 −5
Merged

Add settings and base classes to API reference #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/docs/api-reference/base_classes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: easydynamics.base_classes
9 changes: 6 additions & 3 deletions docs/docs/api-reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,17 @@ icon: material/code-braces-box
This section contains the reference detailing the functions and modules
available in EasyDynamics.

- [analysis](analysis.md) - Analysing experimental data by fitting a
sample model to experimental data, optionally convoluted with a
resolution model and adding a background.
- [base_classes](base_classes.md) - EasyDynamics base classes
- [convolution](convolution.md) – Handles convolution of the sample
model with the instrument resolution.
- [experiment](experiment.md) - Load, manage and visualize experimental
data.
- [sample_model](sample_model.md) – All modelling in EasyDynamics: The
scattering from the sample, including individual model components and
diffusion models, background, resolution and instrument.
- [analysis](analysis.md) - Analysing experimental data by fitting a
sample model to experimental data, optionally convoluted with a
resolution model and adding a background.
- [settings](settings.md) - Settings for numerical convolution and
detailed balance correction
- [utils](utils.md) – Miscellaneous utility functions for EasyDynamics.
1 change: 1 addition & 0 deletions docs/docs/api-reference/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: easydynamics.settings
6 changes: 4 additions & 2 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,8 +200,10 @@ nav:
- Analysis 1D: tutorials/analysis1d.ipynb
- API Reference:
- API Reference: api-reference/index.md
- analysis: api-reference/analysis.md
- base_classes: api-reference/base_classes.md
- convolution: api-reference/convolution.md
- sample_model: api-reference/sample_model.md
- experiment: api-reference/experiment.md
- analysis: api-reference/analysis.md
- sample_model: api-reference/sample_model.md
- settings: api-reference/settings.md
- utils: api-reference/utils.md
Loading