Skip to content

Commit 95bdec9

Browse files
committed
Add uncertainty and conventions in docs/api
1 parent d348070 commit 95bdec9

4 files changed

Lines changed: 36 additions & 2 deletions

File tree

docs/api/conventions/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Conventions (`pygeoid.conventions`)
2+
===================================
3+
4+
.. automodule:: pygeoid.conventions
5+
6+
Units (`pygeoid.conventions.units`)
7+
-----------------------------------
8+
9+
.. automodule:: pygeoid.conventions.units
10+
:members:
11+
12+
Constants (`pygeoid.conventions.constants`)
13+
-------------------------------------------
14+
15+
.. automodule:: pygeoid.conventions.constants
16+
17+
DE440 Constants (`pygeoid.conventions.constants.de440`)
18+
-------------------------------------------------------
19+
20+
.. automodule:: pygeoid.conventions.constants.de440
21+
:members:
22+
23+
IERS 2010 Constants (`pygeoid.conventions.constants.iers2010`)
24+
--------------------------------------------------------------
25+
26+
.. automodule:: pygeoid.conventions.constants.iers2010
27+
:members:

docs/api/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ API Reference
99
:hidden:
1010

1111
geometry/index
12+
conventions/index
1213
estimation/index
1314
fields/index
1415
earth/index
1516
io/index
1617
numerics/index
1718
observations/index
1819
reference/index
20+
uncertainty/index

docs/api/uncertainty/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Uncertainty (`pygeoid.uncertainty`)
2+
===================================
3+
4+
.. automodule:: pygeoid.uncertainty
5+
:members:

src/pygeoid/conventions/constants/iers2010.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ def l2_shida_number(lat: _u.deg = None) -> _u.dimensionless_unscaled:
336336
337337
References
338338
----------
339-
.. [1] IERS Conventions(2010), section 7.1.1, page 105.
339+
- IERS Conventions (2010), section 7.1.1, page 105.
340340
341341
"""
342342
if lat is not None:
@@ -364,7 +364,7 @@ def h2_love_number(lat: _u.deg = None) -> _u.dimensionless_unscaled:
364364
365365
References
366366
----------
367-
.. [1] IERS Conventions(2010), section 7.1.1, page 105.
367+
- IERS Conventions (2010), section 7.1.1, page 105.
368368
369369
"""
370370
if lat is not None:

0 commit comments

Comments
 (0)