Documentation and CodeCov

Project.toml

@@ -10,9 +10,9 @@ OhMyThreads = "67456a42-1dca-4109-a031-0a68de7e3ad5"
 SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 
 [compat]
-julia = "1"
 LinearMaps = "3"
 OhMyThreads = "0.8.3"
+julia = "1"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"

README.md

@@ -1,6 +1,24 @@
+
+
 # BlockSparseMatrices
 
+<p align="center">
+  <img src="docs/src/assets/logo.svg" alt="Description" width="150"/>
+</p>
+
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://djukic14.github.io/BlockSparseMatrices.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://djukic14.github.io/BlockSparseMatrices.jl/dev/)
 [![Build Status](https://github.com/djukic14/BlockSparseMatrices.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/djukic14/BlockSparseMatrices.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/djukic14/BlockSparseMatrices.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/djukic14/BlockSparseMatrices.jl)
+
+
+## Introduction
+This package provides an AbstractMatrix object that allows to construct sparse block matrices. 
+
+## Installation 
+The package can be installed by 
+
+```@julia
+import Pkg
+Pkg.add("https://github.com/djukic14/BlockSparseMatrices.jl")
+```

docs/make.jl

@@ -14,7 +14,18 @@ makedocs(;
         edit_link="main",
         assets=String[],
     ),
-    pages=["Home" => "index.md"],
+    pages=[
+        "Introduction" => "index.md",
+        "Manual" => "manual.md",
+        "Further Details" => "details.md",
+        "Contributing" => "contributing.md",
+        "API Reference" => "apiref.md",
+    ],
 )
 
-deploydocs(; repo="github.com/djukic14/BlockSparseMatrices.jl", devbranch="main")
+deploydocs(;
+    repo="github.com/djukic14/BlockSparseMatrices.jl",
+    target="build",
+    #devbranch="dev",
+    versions=["stable" => "v^"],#=, "dev" => "dev"=#
+)

docs/src/apiref.md

@@ -0,0 +1,14 @@
+# API Reference
+
+## Types
+```@docs
+BlockSparseMatrices.BlockSparseMatrix
+BlockSparseMatrices.SymmetricBlockMatrix
+BlockSparseMatrices.DenseMatrixBlock
+```
+
+## Functions
+```@docs
+BlockSparseMatrices.findcolor!
+BlockSparseMatrices.islessinordering
+```