Merge pull request #175 from JuliaArrays/docs-setup

ChrisRackauckas · web-flow · commit deccaf8ef825 · 2021-07-29T10:46:09.000-04:00
Basic docs setup
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # ArrayInterface.jl
 
+
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://github.com/JuliaArrays/ArrayInterface.jl/stable)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://github.com/JuliaArrays/ArrayInterface.jl/dev)
 [![CI](https://github.com/SciML/ArrayInterface.jl/workflows/CI/badge.svg)](https://github.com/SciML/ArrayInterface.jl/actions?query=workflow%3ACI)
 [![CI (Julia nightly)](https://github.com/SciML/ArrayInterface.jl/workflows/CI%20(Julia%20nightly)/badge.svg)](https://github.com/SciML/ArrayInterface.jl/actions?query=workflow%3A%22CI+%28Julia+nightly%29%22)
 [![Build status](https://badge.buildkite.com/a2db252d92478e1d7196ee7454004efdfb6ab59496cbac91a2.svg?branch=master)](https://buildkite.com/julialang/arrayinterface-dot-jl)
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/make.jl b/docs/make.jl
@@ -0,0 +1,15 @@
+using ArrayInterface
+using Documenter
+
+makedocs(;
+    modules=[ArrayInterface],
+    sitename="ArrayInterface",
+    pages=[
+        "Home" => "index.md",
+    ],
+)
+
+deploydocs(;
+    repo="github.com/JuliaArrays/ArrayInterface.jl",
+)
+
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,12 @@
+```@meta
+CurrentModule = ArrayInterface
+```
+
+# ArrayInterface
+
+```@index
+```
+
+```@autodocs
+Modules = [ArrayInterface]
+```
diff --git a/src/indexing.jl b/src/indexing.jl
@@ -79,13 +79,6 @@ end
 _layout(::IndexLinear, x::Tuple) = LinearIndices(x)
 _layout(::IndexCartesian, x::Tuple) = CartesianIndices(x)
 
-"""
-    ArrayStyle(::Type{A})
-
-Used to customize the meaning of indexing arguments in the context of a given array `A`.
-
-See also: [`argdims`](@ref), [`UnsafeIndex`](@ref)
-"""
 abstract type ArrayStyle end
 
 struct DefaultArrayStyle <: ArrayStyle end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[deps]`
	`2`	`+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"`