From 601eb39ddcde42620c77fa44a1fbb18c8eb1a556 Mon Sep 17 00:00:00 2001
From: Max Horn <max@quendi.de>
Date: Wed, 17 May 2023 17:24:50 +0200
Subject: [PATCH] Add minimal documentation stub (#40)

---
 .github/workflows/ci.yml | 26 +++++++++++++-------------
 .gitignore               |  2 ++
 README.md                |  8 ++++++++
 docs/Project.toml        |  5 +++++
 docs/make.jl             | 11 +++++++++++
 docs/src/index.md        | 20 ++++++++++++++++++++
 6 files changed, 59 insertions(+), 13 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 docs/Project.toml
 create mode 100644 docs/make.jl
 create mode 100644 docs/src/index.md

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 6099ff4..97683ee 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -36,16 +36,16 @@ jobs:
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v3
 
-#   Documentation:
-#     runs-on: ubuntu-latest
-#     steps:
-#       - uses: actions/checkout@v3
-#       - uses: julia-actions/setup-julia@latest
-#         with:
-#           version: 1
-#       - uses: julia-actions/cache@v1
-#         with:
-#           cache-registries: "true"
-#       - uses: julia-actions/julia-docdeploy@releases/v1
-#         env:
-#           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+  Documentation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 1
+      - uses: julia-actions/cache@v1
+        with:
+          cache-registries: "true"
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6e24bde
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+Manifest.toml
+/docs/build/
diff --git a/README.md b/README.md
index c2c498e..ee8b1f5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,13 @@
 # Scratch.jl
 
+[![CI](https://github.com/JuliaPackaging/Scratch.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/JuliaPackaging/Scratch.jl/actions/workflows/ci.yml)
+
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliapackaging.github.io/Scratch.jl/stable)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliapackaging.github.io/Scratch.jl/dev)
+
+[![codecov](https://codecov.io/gh/JuliaPackaging/Scratch.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaPackaging/Scratch.jl)
+
+
 This repository implements the scratch spaces API for package-specific mutable containers of data.
 These spaces can contain datasets, text, binaries, or any other kind of data that would be convenient to store in a location specific to your package.
 As compared to [Artifacts](https://pkgdocs.julialang.org/v1/artifacts/), these containers of data are mutable.
diff --git a/docs/Project.toml b/docs/Project.toml
new file mode 100644
index 0000000..1a6d309
--- /dev/null
+++ b/docs/Project.toml
@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "~0.27"
diff --git a/docs/make.jl b/docs/make.jl
new file mode 100644
index 0000000..db72c90
--- /dev/null
+++ b/docs/make.jl
@@ -0,0 +1,11 @@
+using Documenter, Scratch
+
+makedocs(
+    modules = [Scratch],
+    sitename = "Scratch.jl",
+)
+
+deploydocs(
+    repo = "github.com/JuliaPackaging/Scratch.jl.git",
+    push_preview = true,
+)
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000..9707e62
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,20 @@
+# Scratch.jl Documentation
+
+This is the reference documentation of
+[`Scratch.jl`](https://github.com/JuliaPackaging/Scratch.jl).
+
+## Index
+```@index
+```
+
+## Macros
+```@autodocs
+Modules = [Scratch]
+Order = [:macro]
+```
+
+## Functions
+```@autodocs
+Modules = [Scratch]
+Order = [:function]
+```