WIP: Time module, improved documentation.

docs/make.jl

@@ -13,11 +13,13 @@ makedocs(
         "Modules" => Any[
             "modules/constants.md",
             "modules/universe.md",
+            "modules/time.md",
+            "Function Index" => "modules/function_index.md",
         ],
-        "Tutorials" => Any[
-            "tutorials/universe_example.md",
-            "tutorials/epoch_example.md",
-        ]
+        # "Tutorials" => Any[
+        #     "tutorials/universe_example.md",
+        #     "tutorials/epoch_example.md",
+        # ],
     ]
 )
 

docs/src/index.md

@@ -53,9 +53,4 @@ The software in this package was developed as part of academic research.
 If you would like to help support it, please star the repository as such metrics on
 usage help guage interest and secure funding. If you use the software as part of
 your research, teaching, or other activities, we would be grateful if you could
-cite our work.
-
-## Index
-
-```@index
-```
+cite our work.

docs/src/modules/function_index.md

@@ -0,0 +1,16 @@
+# Function Library
+
+## Constants
+```@index
+Modules = [SatelliteDynamics.Constants]
+```
+
+## Universe
+```@index
+Modules = [SatelliteDynamics.Universe]
+```
+
+## Time
+```@index
+Modules = [SatelliteDynamics.Time]
+```

docs/src/modules/time.md

@@ -0,0 +1,16 @@
+# Time
+
+The Time submodule contains common time transformations such as converting between different date representations or converting a specific instant in time between different time systems.
+
+The module also defines the `Epoch` class which p
+
+Most of the transformations are make backend calls to the SOFA C-library functions provide the package [SOFA.jl](https://github.com/sisl/SOFA.jl "SOFA.jl")
+
+```@docs
+caldate_to_mjd
+mjd_to_caldate
+caldate_to_jd
+jd_to_caldate
+elapsed_from_epoch
+days_from_elapsed
+```

src/SatelliteDynamics.jl

@@ -1,13 +1,13 @@
+__precompile__(true)
 module SatelliteDynamics
 
 # Usings
 using Reexport
-using LinearAlgebra
 
 # Includes
 include("constants.jl")
 include("universe.jl")
-# include("time.jl")
+include("time.jl")
 # include("refsys.jl")
 # include("coordinates.jl")
 # include("astrodynamics.jl")
@@ -18,7 +18,7 @@ include("universe.jl")
 # Export Values
 @reexport using SatelliteDynamics.Constants
 @reexport using SatelliteDynamics.Universe
-# @reexport using SatelliteDynamics.Time
+@reexport using SatelliteDynamics.Time
 # @reexport using SatelliteDynamics.RefSys
 # @reexport using SatelliteDynamics.Coordinates
 # @reexport using SatelliteDynamics.Astrodynamics