docs: Add sun module (#114)

uber-web · Oct 3, 2019 · b0b24da · b0b24da
1 parent f9c1766
commit b0b24da
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 3 deletions.
diff --git a/docs/table-of-contents.json b/docs/table-of-contents.json
@@ -36,6 +36,12 @@
             {"entry": "modules/geospatial/docs/developer-guide/geospatial-guide"}
           ]
         },
+        {
+          "title": "@math.gl/sun",
+          "entries": [
+            {"entry": "modules/sun/docs/developer-guide/sun-guide"}
+          ]
+        },
         {
           "title": "viewport-mercator-project",
           "entries": [
@@ -84,6 +90,13 @@
             {"entry": "modules/geospatial/docs/api-reference/helpers"}
           ]
         },
+        {
+          "title": "@math.gl/sun",
+          "entries": [
+            {"entry": "modules/sun/docs/api-reference/get-sun"},
+            {"entry": "modules/sun/docs/api-reference/get-sun-direction"}
+          ]
+        },
         {
           "title": "viewport-mercator-project",
           "entries": [

diff --git a/modules/sun/docs/api-reference/get-sun-direction.md b/modules/sun/docs/api-reference/get-sun-direction.md
@@ -0,0 +1,3 @@
+# getSunDirection
+
+> TBA
diff --git a/modules/sun/docs/api-reference/get-sun.md b/modules/sun/docs/api-reference/get-sun.md
@@ -0,0 +1,3 @@
+# getSun
+
+> TBA
diff --git a/modules/sun/docs/api-reference/sun.md → ...les/sun/docs/developer-guide/sun-guide.md b/modules/sun/docs/api-reference/sun.md → ...les/sun/docs/developer-guide/sun-guide.md
@@ -1,4 +1,4 @@
-# Sun
+# Overview
 
 `@math.gl/sun` is a tiny JavaScript library for calculating sun position for the given location and time.
 
@@ -8,7 +8,6 @@
 npm install @math.gl/sun
 ```
 
-
 ## Usage
 
 ```js
@@ -20,4 +19,4 @@ const sunDir = getSunDirection(Date.now(), latitude, longitude);
 
 ## Attribution
 
-This class was ported from [SunCalc](https://github.com/mourner/suncalc) under BSD-license.
+This module is a fork of @mourner's [SunCalc](https://github.com/mourner/suncalc) under BSD 2-clause license.