Add documentation with Documenter.jl (#152)

* add documentation with Documenter.jl

* add workflow to documenter

* update doctest results

* add badges to README

Author: hyrodium

.github/workflows/docs.yml

@@ -0,0 +1,17 @@
+name: Documentation
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+  pull_request:
+jobs:
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

README.md

@@ -1,6 +1,8 @@
 # IntervalSets.jl
 Interval Sets for Julia
 
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaMath.github.io/IntervalSets.jl/stable)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaMath.github.io/IntervalSets.jl/dev)
 [![Build Status](https://github.com/JuliaMath/IntervalSets.jl/workflows/CI/badge.svg)](https://github.com/JuliaMath/IntervalSets.jl/actions)
 [![Coverage](https://codecov.io/gh/JuliaMath/IntervalSets.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaMath/IntervalSets.jl)
 

docs/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+IntervalSets = "8197267c-284f-5f27-9208-e0e47529a953"

docs/make.jl

@@ -0,0 +1,23 @@
+using IntervalSets
+using Documenter
+
+DocMeta.setdocmeta!(IntervalSets, :DocTestSetup, :(using IntervalSets); recursive=true)
+
+makedocs(;
+    modules=[IntervalSets],
+    repo="https://github.com/JuliaMath/IntervalSets.jl/blob/{commit}{path}#{line}",
+    sitename="IntervalSets.jl",
+    format=Documenter.HTML(;
+        prettyurls=get(ENV, "CI", "false") == "true",
+        canonical="https://JuliaMath.github.io/IntervalSets.jl",
+        assets = ["assets/custom.css", "assets/favicon.ico"],
+    ),
+    pages=[
+        "Home" => "index.md",
+        "APIs" => "api.md",
+    ],
+)
+
+deploydocs(;
+    repo="github.com/JuliaMath/IntervalSets.jl", devbranch="master",
+)

docs/src/api.md

@@ -0,0 +1,6 @@
+# API
+
+```@autodocs
+Modules = [IntervalSets]
+Order   = [:type, :function]
+```

docs/src/index.md

@@ -0,0 +1,15 @@
+# IntervalSets.jl
+
+A Julia package implementing [IntervalSets](https://en.wikipedia.org/wiki/Quaternion).
+
+!!! note "Documentation"
+    The documentation is still work in progress.
+    For more information, see also
+    * [README in the repository](https://github.com/JuliaMath/IntervalSets.jl)
+    * [Tests in the repository](https://github.com/JuliaMath/IntervalSets.jl/tree/master/test)
+    Feel free to [open pull requests](https://github.com/JuliaMath/IntervalSets.jl/pulls) and improve this document!
+
+## Installation
+```
+pkg> add IntervalSets
+```

src/findall.jl

@@ -25,7 +25,7 @@ julia> y = 8:-0.5:0
 
 julia> collect(y)'
 1×17 adjoint(::Vector{Float64}) with eltype Float64:
- 8.0  7.5  7.0  6.5  6.0  5.5  5.0  4.5  4.0  3.5  3.0  2.5  2.0  1.5  1.0  0.5  0.0
+ 8.0  7.5  7.0  6.5  6.0  5.5  5.0  4.5  …  3.0  2.5  2.0  1.5  1.0  0.5  0.0
 
 julia> findall(in(1..6), y)
 5:15