Expanding Documentation

nc5ng · Aug 12, 2018 · 52464e2 · 52464e2
1 parent eb97cc8
commit 52464e2
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -83,7 +83,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/index.rst b/docs/index.rst
@@ -9,10 +9,11 @@ Welcome to nc5ng's documentation!
 .. toctree::
    :maxdepth: 2
 
+   installing
+   nc5ng-nc5data
    nc5ng-gmt
+   nc5ng-types
 
-
-
 
 Indices and tables
 ==================

diff --git a/docs/installing.rst b/docs/installing.rst
@@ -0,0 +1,38 @@
+Installation
+============
+
+Installation instructions for generic packages
+
+Requirements
+------------
+
+- Fortran (``f77``, ``gfortran``)
+- GMT/Python (Optional)
+  - GMT6.0 (Unreleased)    
+
+
+`pip`
+-----
+
+``nc5ng`` can be installed directly through `pip` simply by running
+
+``pip install nc5ng``
+
+
+
+
+`Docker`
+--------
+
+Docker images are provided to evaluate nc5ng. Pre-configured images are available from the  `nc5ng-docker <https://www.nc5ng.org/projects/nc5ng-docker>`_ project (`Dockerhub <https://hub.docker.com/r/nc5ng/nc5ng>`_), and base images with gmt tools are available from the `gmt-docker <https://www.nc5ng.org/projects/gmt-docker>`_ project (`Dockerhub <https://hub.docker.com/r/nc5ng/gmt>`_)
+
+`NADCON5.0` Conversion Data
+---------------------------
+
+Source data is provided directly from the `nc5ng-core` package. However conversion data must either be built or downloaded seperately.
+
+
+Conversion data are released publically on the `nadcon5-ng github <https://github.com/nc5ng/nadcon5-ng/releases>`_ or upstream via National Geodetic Survey. For compilation please see the source library `docs <https://docs.nc5ng.org/latest>`_ , `project homepage <https://www.nc5ng.org/project/nadcon5-ng>`_, and `github <https://github.com/nc5ng/nadcon5-ng>`_
+
+
+Conversion data can be placed anywhere and is referenced by configration arguments used to load data.
diff --git a/docs/nc5ng-gmt.rst b/docs/nc5ng-gmt.rst
@@ -1,6 +1,5 @@
-
-
-`nc5ng.gmt` package reference
+=============================
+`nc5ng.gmt` Package Reference
 =============================
 
 

diff --git a/docs/nc5ng-nc5data.rst b/docs/nc5ng-nc5data.rst
@@ -0,0 +1,9 @@
+=================================
+`nc5ng.nc5data` Package Reference
+=================================
+
+
+**PyPi Package:** ``nc5ng-core``
+
+
+.. automodule:: nc5ng.nc5data
diff --git a/docs/nc5ng-types.rst b/docs/nc5ng-types.rst
@@ -0,0 +1,11 @@
+===============================
+`nc5ng.types` Package Reference
+===============================
+
+
+**PyPi Package:** ``nc5ng-common``
+
+
+
+.. automodule:: nc5ng.types
+