fixdocs

Author: Wimmerer

.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: '1.6'
+      - 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 }} # If authenticating with GitHub Actions token
+        run: julia --project=docs/ docs/make.jl

.travis.yml

@@ -1,10 +1,9 @@
 name = "SuiteSparseGraphBLAS"
 uuid = "c2e53296-7b14-11e9-1210-bddfa8111e1d"
-authors = ["Abhinav Mehndiratta <[email protected]>"]
-version = "0.3.4"
+authors = ["Will Kimmerer <[email protected]", "Abhinav Mehndiratta <[email protected]>"]
+version = "0.4"
 
 [deps]
-BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"
 Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
@@ -15,4 +14,4 @@ SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [compat]
-julia = "1.3"
+julia = "1.6"

Project.toml

@@ -1,3 +1,2 @@
 [deps]
-Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-SuiteSparseGraphBLAS = "c2e53296-7b14-11e9-1210-bddfa8111e1d"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/Project.toml

@@ -0,0 +1,7 @@
+using Documenter, SuiteSparseGraphBLAS
+
+makedocs(sitename="SuiteSparse:GraphBLAS")
+
+deploydocs(
+    repo = "github.com/JuliaSparse/SuiteSparseGraphBLAS.jl.git",
+)

docs/make.jl

@@ -0,0 +1,18 @@
+# SuiteSparseGraphBLAS.jl
+
+SuiteSparseGraphBLAS.jl is a WIP package for sparse linear algebra on arbitrary semirings, with a particular focus on graph computations.
+It is a wrapper over the Tim Davis' SuiteSparse reference implementation of the GraphBLAS C API, although it aims to expose a Julian interface to the user.
+
+While the core library is mostly complete, and all GraphBLAS functionality is present, there are still quite a few features being worked on:
+
+1. ChainRules.jl integration for AD.
+2. Complete SparseArrays and ArrayInterface interfaces.
+3. Import and Export in all formats including bitmap and csr. Currently only dense and csc are supported.
+4. Printing v2.
+5. User-defined types and functions.
+6. Alternative syntax for GraphBLAS ops (currently must use `BinaryOps.PLUS` instead of `+`).
+7. Complex builtins.
+
+Once these are completed there will be a v1.0 release, with the goal being JuliaCon 2021.
+
+# Introduction