Set up documentation

.github/workflows/documentation.yml

@@ -0,0 +1,24 @@
+name: Documentation
+on:
+  push:
+    branches: [master]
+    tags: '*'
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          # Build documentation on the latest Julia 1.x
+          version: '1'
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.instantiate();
+                                       Pkg.develop(PackageSpec(path=pwd()))'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

README.md

@@ -1,10 +1,16 @@
 # Dionysos
 
-| **Build Status** |
-|:----------------:|
-| [![Build Status][build-img]][build-url] [![Codecov branch][codecov-img]][codecov-url] |
+| **Documentation** | **Build Status** |
+|:-----------------:|:----------------:|
+| [![][docs-stable-img]][docs-stable-url] | [![Build Status][build-img]][build-url] |
+| [![][docs-latest-img]][docs-latest-url] | [![Codecov branch][codecov-img]][codecov-url] |
 
-[build-img]: https://github.com/blegat/Dionysos.jl/workflows/CI/badge.svg?branch=master
-[build-url]: https://github.com/blegat/Dionysos.jl/actions?query=workflow%3ACI
-[codecov-img]: http://codecov.io/github/blegat/Dionysos.jl/coverage.svg?branch=master
-[codecov-url]: http://codecov.io/github/blegat/Dionysos.jl?branch=master
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
+[docs-stable-url]: https://dionysos-dev.github.io/Dionysos.jl/stable
+[docs-latest-url]: https://dionysos-dev.github.io/Dionysos.jl/dev
+
+[build-img]: https://github.com/dionysos-dev/Dionysos.jl/workflows/CI/badge.svg?branch=master
+[build-url]: https://github.com/dionysos-dev/Dionysos.jl/actions?query=workflow%3ACI
+[codecov-img]: http://codecov.io/github/dionysos-dev/Dionysos.jl/coverage.svg?branch=master
+[codecov-url]: http://codecov.io/github/dionysos-dev/Dionysos.jl?branch=master

docs/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "0.26"

docs/make.jl

@@ -0,0 +1,35 @@
+using Dionysos
+using Documenter, Literate
+
+const EXAMPLES_DIR = joinpath(@__DIR__, "..", "examples")
+const OUTPUT_DIR   = joinpath(@__DIR__, "src/generated")
+
+include(joinpath(EXAMPLES_DIR, "all_examples.jl"))
+
+for example in EXAMPLES
+    example_filepath = joinpath(EXAMPLES_DIR, example)
+    Literate.markdown(example_filepath, OUTPUT_DIR)
+    Literate.notebook(example_filepath, OUTPUT_DIR)
+    Literate.script(example_filepath, OUTPUT_DIR)
+end
+
+makedocs(
+    sitename = "Dionysos",
+    # See https://github.com/JuliaDocs/Documenter.jl/issues/868
+    format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
+    # See https://github.com/jump-dev/JuMP.jl/issues/1576
+    strict = true,
+    pages = [
+        "Index" => "index.md",
+        "Examples" => map(EXAMPLES) do jl_file
+            # Need `string` as Documenter fails if `name` is a `SubString{String}`.
+            name = string(split(jl_file, ".")[1])
+            return name => "generated/$name.md"
+        end
+    ],
+)
+
+deploydocs(
+    repo   = "github.com/dionysos-dev/Dionysos.jl.git",
+    push_preview = true,
+)

docs/src/index.md

@@ -0,0 +1,3 @@
+# Dionysos
+
+[Dionysos](https://github.com/dionysos-dev/Dionysos.jl) implements a solver for the optimal control of cyber-physical systems.

examples/all_examples.jl

@@ -0,0 +1 @@
+const EXAMPLES = String[]