Added github workflows and basic docs

.github/workflows/documentation.yml

@@ -0,0 +1,26 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.8.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 }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ --code-coverage=user docs/make.jl

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Run tests
+
+on:
+  push:
+    branches:
+      - main
+    tags: '*'
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Test Julia
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup julia
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: '1.8.1'
+      - run: julia -e 'using Pkg; pkg"add [email protected]"'
+      - run: julia -e 'using Run; Run.prepare_test()'
+      - run: julia -e 'using Run; Run.test()'
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: ./lcov.info
+          flags: unittests
+          name: codecov-umbrella

.gitignore

@@ -1,3 +1,4 @@
 /Manifest.toml
 /assets/tmp/*
 /test/livetest.jl
+/docs/build/

Project.toml

@@ -5,6 +5,7 @@ version = "0.1.0"
 
 [deps]
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 GraphMakie = "1ecd5474-83a3-4783-bb4f-06765db800d2"
 Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
@@ -13,14 +14,15 @@ NestedGraphs = "03c36417-ddab-428a-818d-5359aee292ef"
 NetworkLayout = "46757867-2c16-5918-afeb-47bfcb05e46a"
 
 [compat]
-julia = "1.8"
+DocStringExtensions = "0.9"
 Colors = "0.12.10"
 GraphMakie = "0.4, 0.5"
-Graphs = "1.8"
+Graphs = "1"
 Makie = "0.18, 0.19"
 MultiKDE = "0.1"
 NestedGraphs = "0.1.1"
 NetworkLayout = "0.4.5"
+julia = "1.8"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -1,12 +1,10 @@
 # NestedGraphMakie
 
 A package for [NestedGraphs.jl](https://github.com/UniStuttgart-IKR/NestedGraphs.jl) to make easy visualizations.
-See the [NestedGraphs.jl]() docs for some examples
 
 This package exports `ngraphplot`, which provides some extra features on top of `GraphMakie.graphplot`.
 All features of `GraphMakie.graphplot` can be accesssed whatsoever.
-
-See the [API]() of `ngraphplot`
+See the [API](github.com/UniStuttgart-IKR/NestedGraphMakie.jl.git/API/) docs.
 
 Some examples of `NestedGraph` visualizations:
 ```julia