reorganize docs

ioshchepkov · Apr 15, 2021 · 86b2933 · 86b2933
1 parent c15b565
commit 86b2933
Show file tree

Hide file tree

Showing 25 changed files with 76 additions and 9 deletions.
diff --git a/README.rst b/README.rst
@@ -34,6 +34,12 @@ To install ``pygeoid`` simply use ``pip`` as usual:
 
     pip install pygeoid
 
+Alternatively, you can use ``pip`` to install the latest version of the source code from GitHub:
+
+.. code:: bash
+
+    pip install --upgrade git+https://github.com/ioshchepkov/pygeoid
+
 Documentation
 -------------
 

diff --git a/docs/coordinates/ellipsoid.rst → docs/api/coordinates/ellipsoid.rst b/docs/coordinates/ellipsoid.rst → docs/api/coordinates/ellipsoid.rst
@@ -3,6 +3,6 @@
 Reference Ellipsoid (`pygeoid.coordinates.ellipsoid.Ellipsoid`)
 ***************************************************************
 
-.. autoclass:: pygeoid.coordinates.ellipsoid.Ellipsoid
+.. automodule:: pygeoid.coordinates.ellipsoid
    :members:
    :inherited-members:
diff --git a/docs/coordinates/index.rst → docs/api/coordinates/index.rst b/docs/coordinates/index.rst → docs/api/coordinates/index.rst
diff --git a/docs/coordinates/position.rst → docs/api/coordinates/position.rst b/docs/coordinates/position.rst → docs/api/coordinates/position.rst
diff --git a/docs/coordinates/transform.rst → docs/api/coordinates/transform.rst b/docs/coordinates/transform.rst → docs/api/coordinates/transform.rst
@@ -5,3 +5,4 @@ Coordinate Transformations (`pygeoid.coordinates.transform`)
 
 .. automodule:: pygeoid.coordinates.transform
    :members:
+
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,16 @@
+
+.. _api:
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   coordinates/index
+   integrals/index
+   reduction/index
+   sharm/index
+   simple/index
+   tides/index
diff --git a/docs/integrals/index.rst → docs/api/integrals/index.rst b/docs/integrals/index.rst → docs/api/integrals/index.rst
diff --git a/docs/integrals/stokes.rst → docs/api/integrals/stokes.rst b/docs/integrals/stokes.rst → docs/api/integrals/stokes.rst
diff --git a/docs/integrals/truncation.rst → docs/api/integrals/truncation.rst b/docs/integrals/truncation.rst → docs/api/integrals/truncation.rst
diff --git a/docs/integrals/veningmeinesz.rst → docs/api/integrals/veningmeinesz.rst b/docs/integrals/veningmeinesz.rst → docs/api/integrals/veningmeinesz.rst
diff --git a/docs/reduction/atmosphere.rst → docs/api/reduction/atmosphere.rst b/docs/reduction/atmosphere.rst → docs/api/reduction/atmosphere.rst
diff --git a/docs/reduction/index.rst → docs/api/reduction/index.rst b/docs/reduction/index.rst → docs/api/reduction/index.rst
diff --git a/docs/reduction/normal.rst → docs/api/reduction/normal.rst b/docs/reduction/normal.rst → docs/api/reduction/normal.rst
diff --git a/docs/reduction/topography.rst → docs/api/reduction/topography.rst b/docs/reduction/topography.rst → docs/api/reduction/topography.rst
diff --git a/docs/sharm/ggm.rst → docs/api/sharm/ggm.rst b/docs/sharm/ggm.rst → docs/api/sharm/ggm.rst
diff --git a/docs/sharm/index.rst → docs/api/sharm/index.rst b/docs/sharm/index.rst → docs/api/sharm/index.rst
diff --git a/docs/sharm/legendre.rst → docs/api/sharm/legendre.rst b/docs/sharm/legendre.rst → docs/api/sharm/legendre.rst
diff --git a/docs/api/simple/index.rst b/docs/api/simple/index.rst
@@ -0,0 +1,9 @@
+
+**************************************************************
+Simpe Bodies (`pygeoid.simple`)
+**************************************************************
+
+.. toctree::
+   :maxdepth: 1
+
+   prism
diff --git a/docs/api/simple/prism.rst b/docs/api/simple/prism.rst
@@ -0,0 +1,8 @@
+
+*******************************************************************
+Prism (`pygeoid.simple.prism`)
+*******************************************************************
+
+.. autoclass:: pygeoid.simple.prism.Prism
+   :members:
+   :inherited-members:
diff --git a/docs/tides/index.rst → docs/api/tides/index.rst b/docs/tides/index.rst → docs/api/tides/index.rst
diff --git a/docs/tides/laplace.rst → docs/api/tides/laplace.rst b/docs/tides/laplace.rst → docs/api/tides/laplace.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
     'sphinx.ext.doctest',
     'sphinx.ext.todo',
@@ -58,7 +59,7 @@
 
 # General information about the project.
 project = 'pygeoid'
-copyright = '2019, Ilya Oshchepkov'
+copyright = '2019-2021, Ilya Oshchepkov'
 author = 'Ilya Oshchepkov'
 
 # The version info for the project you're documenting, acts as replacement for

diff --git a/docs/index.rst b/docs/index.rst
@@ -5,22 +5,23 @@ Welcome to pygeoid's documentation!
 .. include:: ../README.rst
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
+  :hidden:
   :caption: Getting Started
 
+  install.rst
+
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
+  :hidden:
   :caption: User Guide
 
 .. toctree::
   :maxdepth: 2
+  :hidden:
   :caption: Reference Guide
 
-  Coordinate Systems and Transformations <coordinates/index>
-  Gravity Reduction <reduction/index>
-  Geodetic Integrals <integrals/index>
-  Spherical Harmonics <sharm/index>
-  Tides <tides/index>
+  api/index.rst
 
 .. toctree::
   :maxdepth: 1

diff --git a/docs/install.rst b/docs/install.rst
@@ -0,0 +1,22 @@
+.. _install
+
+Installing
+==========
+
+Installing with pip
+-------------------
+
+You can install ``pygeoid`` using the `pip package manager
+<https://pypi.org/project/pip/>`__::
+
+    pip install pygeoid
+
+
+Installing the latest development version
+-----------------------------------------
+
+You can use ``pip`` to install the latest version of the source code from
+GitHub::
+
+    python -m pip install --upgrade git+https://github.com/ioshchepkov/pygeoid
+
diff --git a/pygeoid/constants/iers2010.py b/pygeoid/constants/iers2010.py
@@ -223,6 +223,9 @@ def l2_shida_number(lat: _u.deg = None) -> _u.dimensionless_unscaled:
     l2 : ~astropy.units.Quantity
         Nominal degree 2 Shida number.
 
+    Notes
+    -----
+
     References
     ----------
     .. [1] IERS Conventions(2010), section 7.1.1, page 105.