Naive documentation first implementation

.github/workflows/documentation.yml

@@ -0,0 +1,26 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - documentation # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.6'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+        run: julia --project=docs/ docs/make.jl

.gitignore

@@ -13,3 +13,6 @@ tests/Theta*
 tests/Isochrone*
 tests/Basis*
 tests/*Validation*
+
+# Documentation (avoid committing generated content)
+docs/build/

docs/make.jl

@@ -0,0 +1,12 @@
+# Adding the package src to the load path
+push!(LOAD_PATH,"../src/")
+
+using Documenter, OrbitalElements
+
+makedocs(sitename = "OrbitalElements.jl",
+         pages=[
+                "Home" => "index.md",
+                "Functions" => "functions.md"
+               ],
+         format = Documenter.HTML(prettyurls=false))
+deploydocs(repo="github.com/michael-petersen/OrbitalElements.jl")

docs/src/functions.md

@@ -0,0 +1,44 @@
+
+# Systems
+
+## Potentials
+```@docs
+OrbitalElements.dψMestel
+```
+
+## Distribution functions
+```@docs
+OrbitalElements.Miyamoto_DF
+OrbitalElements.IsoDiscKal_DF
+OrbitalElements.IsoDiscPLB_ndDFdJ
+OrbitalElements.ZangOuterTaperdL
+```
+
+# Changes of coordinates
+```@docs
+OrbitalElements.Ω1circular
+OrbitalElements.EFromAE
+OrbitalElements.ELFromAE
+OrbitalElements.ComputeActionsAE
+OrbitalElements.FrequenciesFromαβ
+OrbitalElements.Getϖ
+OrbitalElements.FindVbound
+OrbitalElements.RcircFromΩ2circ
+```
+
+## Isochrone specific functions
+```@docs
+OrbitalElements.IsochroneβAE
+```
+
+## Plummer specific functions
+```@docs
+OrbitalElements.dΘRpRaPlummer
+OrbitalElements.PlummerELFromSpSa
+```
+
+# Utility functions
+```@docs
+OrbitalElements.NonAsciiHandle
+OrbitalElements.GetResLinesJL
+```

docs/src/index.md

@@ -0,0 +1,4 @@
+# OrbitalElements.jl
+
+*Galactic dynamics orbits in Julia*
+