Setup documentation

.github/workflows/Documentation.yml

@@ -0,0 +1,31 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1'
+      - 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 }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+        run: julia --project=docs/ --code-coverage=user docs/make.jl
+      - uses: julia-actions/julia-processcoverage@v1
+        with:
+          directories: src
+      - uses: codecov/codecov-action@v3
+        with:
+          files: lcov.info

docs/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Neuroblox = "769b91e5-4c60-41ee-bfae-153c84203cb2"
+
+[compat]
+Documenter = "1"

docs/make.jl

@@ -0,0 +1,22 @@
+using Neuroblox
+using Documenter
+
+cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
+cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
+
+DocMeta.setdocmeta!(Neuroblox, :DocTestSetup, :(using Neuroblox); recursive = true)
+
+include("pages.jl")
+
+makedocs(sitename = "Neuroblox",
+    authors = "Neuroblox Inc.",
+    modules = [Neuroblox],
+    clean = true, doctest = false, linkcheck = true,
+    warnonly = [:docs_block, :missing_docs],
+    format = Documenter.HTML(assets = ["assets/favicon.ico"],
+        #canonical = "https://docs.sciml.ai/LinearSolve/stable/"),
+    pages = pages)
+
+deploydocs(;
+    repo = "github.com/Neuroblox/Neuroblox.jl",
+    push_preview = true)

docs/pages.jl

@@ -0,0 +1,9 @@
+# Put in a separate page so it can be used by SciMLDocs.jl
+
+pages = ["index.md",
+    "getting_started.md",
+    #"Tutorials" => Any[],
+    #"Manual" => Any[],
+    "API" => "api.md",
+    "Release Notes" => "release_notes.md",
+]

docs/src/api.md

@@ -0,0 +1,5 @@
+# API Documentation
+
+```@autodocs
+Modules = [Neuroblox]
+```

docs/src/index.md

@@ -0,0 +1,79 @@
+# Neuroblox
+
+## Installation
+
+To install LinearSolve.jl, use the Julia package manager:
+
+```julia
+using Pkg
+Pkg.add("LinearSolve")
+```
+
+## Community Channels
+
+  - There are a few community forums:
+
+      + The #diffeq-bridged and #sciml-bridged channels in the
+        [Julia Slack](https://julialang.org/slack/)
+      + The #diffeq-bridged and #sciml-bridged channels in the
+        [Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+      + On the [Julia Discourse forums](https://discourse.julialang.org)
+      + See also [SciML Community page](https://sciml.ai/community/)
+
+## Reproducibility
+
+```@raw html
+<details><summary>The documentation of this package was built using these direct dependencies,</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>and using this machine and Julia version.</summary>
+```
+
+```@example
+using InteractiveUtils # hide
+versioninfo() # hide
+```
+
+```@raw html
+</details>
+```
+
+```@raw html
+<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
+```
+
+```@example
+using Pkg # hide
+Pkg.status(; mode = PKGMODE_MANIFEST) # hide
+```
+
+```@raw html
+</details>
+```
+
+```@eval
+using TOML
+using Markdown
+version = TOML.parse(read("../../Project.toml", String))["version"]
+name = TOML.parse(read("../../Project.toml", String))["name"]
+link_manifest = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+                "/assets/Manifest.toml"
+link_project = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version *
+               "/assets/Project.toml"
+Markdown.parse("""You can also download the
+[manifest]($link_manifest)
+file and the
+[project]($link_project)
+file.
+""")
+```

docs/src/release_notes.md

@@ -0,0 +1,5 @@
+# Release Notes
+
+## v0.3
+
+Initial Release!