docs

Author: daanhb

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master # update to match your development branch (master, main, dev, trunk, ...)
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      actions: write
+      contents: write
+      pull-requests: read
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v2
+      - 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
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

docs/Project.toml

@@ -1,3 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 FunctionMaps = "a85aefff-f8ca-4649-a888-c8e5398bc76c"
+
+[compat]
+Documenter = "1.8"

docs/make.jl

@@ -13,5 +13,14 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+	    "Examples" => "examples.md",
+        "API" => Any[
+            "Public API Reference" => "api.md",
+            "Internal API Reference" => "internal.md"
+        ],
     ],
 )
+
+deploydocs(;
+    repo="github.com/JuliaApproximation/FunctionMaps.jl", devbranch="master",
+)

docs/src/api.md

@@ -0,0 +1,28 @@
+# Public API Reference
+
+## Constants
+
+```@autodocs
+Modules = [FunctionMaps]
+Order   = [:constant]
+Public  = true
+Private = false
+```
+
+## Functions
+
+```@autodocs
+Modules = [FunctionMaps]
+Order   = [:function]
+Public  = true
+Private = false
+```
+
+## Types
+
+```@autodocs
+Modules = [FunctionMaps]
+Order   = [:type]
+Public  = true
+Private = false
+```

docs/src/examples.md

@@ -4,11 +4,8 @@ CurrentModule = FunctionMaps
 
 # FunctionMaps
 
-Documentation for [FunctionMaps](https://github.com/daanhb/FunctionMaps.jl).
+This is the documentation for [FunctionMaps](https://github.com/JuliaApproximation/FunctionMaps.jl).
 
-```@index
-```
+## What is FunctionMaps.jl
 
-```@autodocs
-Modules = [FunctionMaps]
-```
+FunctionMaps.jl is a package designed to represent scalar- and vector-valued functions. It makes it easy to make new maps from existing ones, via composition or by taking products.

docs/src/index.md

@@ -0,0 +1,35 @@
+# Internal API Reference
+
+This is an exhaustive list of all non-exported constants, types and functions
+in `FunctionMaps.jl`.
+
+!!! warning
+    Unexported functions and types are subject to change across different
+    releases of the package, even if the release is said to be non-breaking.
+
+## Constants
+
+```@autodocs
+Modules = [FunctionMaps]
+Order   = [:constant]
+Public  = false
+Private = true
+```
+
+## Functions
+
+```@autodocs
+Modules = [FunctionMaps]
+Order   = [:function]
+Public  = false
+Private = true
+```
+
+## Types
+
+```@autodocs
+Modules = [FunctionMaps]
+Order   = [:type]
+Public  = false
+Private = true
+```