Skip to content

Commit 86b2933

Browse files
committed
reorganize docs
1 parent c15b565 commit 86b2933

File tree

25 files changed

+76
-9
lines changed

25 files changed

+76
-9
lines changed

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ To install ``pygeoid`` simply use ``pip`` as usual:
3434
3535
pip install pygeoid
3636
37+
Alternatively, you can use ``pip`` to install the latest version of the source code from GitHub:
38+
39+
.. code:: bash
40+
41+
pip install --upgrade git+https://github.com/ioshchepkov/pygeoid
42+
3743
Documentation
3844
-------------
3945

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
Reference Ellipsoid (`pygeoid.coordinates.ellipsoid.Ellipsoid`)
44
***************************************************************
55

6-
.. autoclass:: pygeoid.coordinates.ellipsoid.Ellipsoid
6+
.. automodule:: pygeoid.coordinates.ellipsoid
77
:members:
88
:inherited-members:
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ Coordinate Transformations (`pygeoid.coordinates.transform`)
55

66
.. automodule:: pygeoid.coordinates.transform
77
:members:
8+

docs/api/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
.. _api:
3+
4+
API Reference
5+
=============
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
:hidden:
10+
11+
coordinates/index
12+
integrals/index
13+
reduction/index
14+
sharm/index
15+
simple/index
16+
tides/index
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)