22 improve api documentation - #37

Merged

alkirkby merged 28 commits into

mainfrom

22-improve-api-documentation

Jul 20, 2026

Commits on Jul 14, 2026

some doc updates

craigmillernz
authored and
Adrian Benson
committed
5a41504
Update repo version etc in docs conf.py
Adrian Benson
committed
50e9503
Add doc templats from pandas
Adrian Benson
committed
10a7a13
docs: move images to _static subfolder
Adrian Benson
committed
c677b3e
update template for readable
Adrian Benson
committed
b9b11a2
ignore autogenerate api docs
Adrian Benson
committed
f72a5ca
Add dependencies for jupyter and docs
Adrian Benson
committed
aa94daa
Doc: Do not autogenerate class member doc in sphinx
Adrian Benson
committed
1e90583
Bug: GravityAnomalies - fix incorrect type hint for tcorr_params arg.
Adrian Benson
committed
27f4f21
Doc: Improve docstrings
Adrian Benson
committed
defab3e
Doc: Update docstrings.
Adrian Benson
committed
6895ec6
Doc: Create separate pages to create for pandas style api documntation
Adrian Benson
committed
ab92c64
doc: api for obs, sites and survey
Adrian Benson
committed
0a6ffe9
Add numpydoc and pandas usage checks.
Adrian Benson
committed
51f1460
disable numpydoc validation
Adrian Benson
committed
921024c
Doc: docstring updates
Adrian Benson
committed
638ba3b
doc: Updated api docs - now work on docstrings themselves
Adrian Benson
committed
3519359
doc: add missig docstring elements
Adrian Benson
committed
ccb966c
ignore error no raises section in docstring
Adrian Benson
committed
e0828ce
Update docstrings
Adrian Benson
committed
f8e7bdb
final changes
Adrian Benson
committed
6911df8
Fix failing test
Adrian Benson
committed
c647f09
Potential fix for pull request finding

AdrianBenson
and
Copilot
authored
844179d
Potential fix for pull request finding

AdrianBenson
and
Copilot
authored
0fb58ef
Potential fix for pull request finding

AdrianBenson
and
Copilot
authored
ae6c234
fix reports docstring grammar
Copilot
authored
2688f8b
fix excel writer keyword compatibility
Copilot
authored
05960c4
Fix typos in docstrings and comments.
Adrian Benson
committed
b258892