docs: switch from sphinx-apidoc to sphinx-autosummary

ImperialCollegeLondon · Feb 23, 2025 · a764c02 · a764c02
1 parent 5b28a07
commit a764c02
Show file tree

Hide file tree

Showing 35 changed files with 17 additions and 433 deletions.
diff --git a/.gitignore b/.gitignore
@@ -63,6 +63,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/build/
+docs/*/_autosummary
 
 # PyBuilder
 target/

diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
diff --git a/docs/source/api/pyprobe.analysis.base.degradation_mode_analysis_functions.rst b/docs/source/api/pyprobe.analysis.base.degradation_mode_analysis_functions.rst
diff --git a/docs/source/api/pyprobe.analysis.base.differentiation_functions.rst b/docs/source/api/pyprobe.analysis.base.differentiation_functions.rst
diff --git a/docs/source/api/pyprobe.analysis.base.rst b/docs/source/api/pyprobe.analysis.base.rst
diff --git a/docs/source/api/pyprobe.analysis.cycling.rst b/docs/source/api/pyprobe.analysis.cycling.rst
diff --git a/docs/source/api/pyprobe.analysis.degradation_mode_analysis.rst b/docs/source/api/pyprobe.analysis.degradation_mode_analysis.rst
diff --git a/docs/source/api/pyprobe.analysis.differentiation.rst b/docs/source/api/pyprobe.analysis.differentiation.rst
diff --git a/docs/source/api/pyprobe.analysis.pulsing.rst b/docs/source/api/pyprobe.analysis.pulsing.rst
diff --git a/docs/source/api/pyprobe.analysis.rst b/docs/source/api/pyprobe.analysis.rst
diff --git a/docs/source/api/pyprobe.analysis.smoothing.rst b/docs/source/api/pyprobe.analysis.smoothing.rst
diff --git a/docs/source/api/pyprobe.analysis.utils.rst b/docs/source/api/pyprobe.analysis.utils.rst
diff --git a/docs/source/api/pyprobe.cell.rst b/docs/source/api/pyprobe.cell.rst
diff --git a/docs/source/api/pyprobe.cyclers.arbin.rst b/docs/source/api/pyprobe.cyclers.arbin.rst
diff --git a/docs/source/api/pyprobe.cyclers.basecycler.rst b/docs/source/api/pyprobe.cyclers.basecycler.rst
diff --git a/docs/source/api/pyprobe.cyclers.basytec.rst b/docs/source/api/pyprobe.cyclers.basytec.rst
diff --git a/docs/source/api/pyprobe.cyclers.biologic.rst b/docs/source/api/pyprobe.cyclers.biologic.rst
diff --git a/docs/source/api/pyprobe.cyclers.maccor.rst b/docs/source/api/pyprobe.cyclers.maccor.rst
diff --git a/docs/source/api/pyprobe.cyclers.neware.rst b/docs/source/api/pyprobe.cyclers.neware.rst
diff --git a/docs/source/api/pyprobe.cyclers.rst b/docs/source/api/pyprobe.cyclers.rst
diff --git a/docs/source/api/pyprobe.dashboard.rst b/docs/source/api/pyprobe.dashboard.rst
diff --git a/docs/source/api/pyprobe.filters.rst b/docs/source/api/pyprobe.filters.rst
diff --git a/docs/source/api/pyprobe.logger.rst b/docs/source/api/pyprobe.logger.rst
diff --git a/docs/source/api/pyprobe.plot.rst b/docs/source/api/pyprobe.plot.rst
diff --git a/docs/source/api/pyprobe.pyprobe_types.rst b/docs/source/api/pyprobe.pyprobe_types.rst
diff --git a/docs/source/api/pyprobe.rawdata.rst b/docs/source/api/pyprobe.rawdata.rst
diff --git a/docs/source/api/pyprobe.readme_processor.rst b/docs/source/api/pyprobe.readme_processor.rst
diff --git a/docs/source/api/pyprobe.result.rst b/docs/source/api/pyprobe.result.rst