Merge pull request #207 from ArnoStrouwen/master

add docs

Author: ChrisRackauckas

.github/workflows/Documentation.yml

@@ -0,0 +1,29 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - 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
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info

.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
 Manifest.toml
 /dev/
+
+docs/build/
+docs/site/

README.md

@@ -1,8 +1,14 @@
 # SparseDiffTools.jl
 
-[![Join the chat at https://gitter.im/JuliaDiff/Lobby](https://badges.gitter.im/JuliaDiff/Lobby.svg)](https://gitter.im/JuliaDiff/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Build status](https://badge.buildkite.com/ea7df061e20328f60d3e0816d97d2d856166f2ea7030748cef.svg?branch=master)](https://buildkite.com/julialang/sparsedifftools-dot-jl)
-[![Build status](https://badge.buildkite.com/ea7df061e20328f60d3e0816d97d2d856166f2ea7030748cef.svg)](https://buildkite.com/julialang/sparsedifftools-dot-jl)
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/SparseDiffTools/stable/)
+
+[![codecov](https://codecov.io/gh/JuliaDiff/SparseDiffTools.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaDiff/SparseDiffTools.jl)
+[![Build Status](https://github.com/JuliaDiff/SparseDiffTools.jl/workflows/CI/badge.svg)](https://github.com/JuliaDiff/SparseDiffTools.jl/actions?query=workflow%3ACI)
+[![buildkite](https://badge.buildkite.com/ea7df061e20328f60d3e0816d97d2d856166f2ea7030748cef.svg)](https://buildkite.com/julialang/sparsedifftools-dot-jl)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
 
 This package is for exploiting sparsity in Jacobians and Hessians to accelerate
 computations. Matrix-free Jacobian-vector product and Hessian-vector product

docs/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+SparseDiffTools = "47a9eef4-7e08-11e9-0b38-333d64bd3804"
+
+[compat]
+Documenter = "0.27"

docs/make.jl

@@ -0,0 +1,18 @@
+using Documenter, SparseDiffTools
+
+include("pages.jl")
+
+makedocs(
+    sitename = "SparseDiffTools.jl",
+    authors = "Chris Rackauckas",
+    modules = [SparseDiffTools],
+    clean = true,
+    doctest = false,
+    format = Documenter.HTML(
+        assets = ["assets/favicon.ico"],
+        canonical = "https://docs.sciml.ai/SparseDiffTools/stable/",
+    ),
+    pages = pages,
+)
+
+deploydocs(repo = "https://github.com/JuliaDiff/SparseDiffTools.jl.git"; push_preview = true)

docs/pages.jl

@@ -0,0 +1,3 @@
+# Put in a separate page so it can be used by SciMLDocs.jl
+
+pages = ["Home" => "index.md", "sparsedifftools.md"]