Add docs (#35)

* Add docs

* Fix warning

Author: yuehhua

.gitignore

@@ -2,4 +2,5 @@
 *.jl.*.cov
 *.jl.mem
 deps/deps.jl
+docs/build/
 *.odg

.travis.yml

@@ -5,6 +5,7 @@ language: julia
 os:
   - linux
   - osx
+  - windows
 
 julia:
   - 1.4
@@ -27,21 +28,16 @@ git:
 env:
   - JULIA_CUDA_SILENT=true
 
-## uncomment the following lines to allow failures on nightly julia
-## (tests will run but not make your overall status red)
-matrix:
- allow_failures:
- - julia: nightly
-
-## uncomment and modify the following lines to manually install system packages
-#addons:
-#  apt: # apt-get for linux
-#    packages:
-#    - gfortran
-#before_script: # homebrew for mac
-#  - if [ $TRAVIS_OS_NAME = osx ]; then brew install gcc; fi
-
-# uncomment the following lines to override the default test script
-# script:
-#  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-#  - julia -e 'using Pkg; Pkg.add(PackageSpec(url=pwd())); Pkg.build("GeometricFlux"); Pkg.test("GeometricFlux"; coverage=true)'
+jobs:
+  allow_failures:
+    - julia: nightly
+  fast_finish: true
+  include:
+    - stage: Documentation
+      julia: 1.4
+      script: julia --project=docs -e '
+          using Pkg;
+          Pkg.develop(PackageSpec(path=pwd()));
+          Pkg.instantiate();
+          include("docs/make.jl");'
+      after_success: skip

README.md

@@ -4,6 +4,8 @@
 <img width="400px" src="https://github.com/yuehhua/GeometricFlux.jl/raw/master/logos/logo.png"/>
 </p>
 
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://yuehhua.github.io/GeometricFlux.jl/stable)
+[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://yuehhua.github.io/GeometricFlux.jl/dev)
 [![Build Status](https://travis-ci.org/yuehhua/GeometricFlux.jl.svg?branch=master)](https://travis-ci.org/yuehhua/GeometricFlux.jl)
 [![codecov](https://codecov.io/gh/yuehhua/GeometricFlux.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/yuehhua/GeometricFlux.jl)
 [![pipeline status](https://gitlab.com/JuliaGPU/GeometricFlux-jl/badges/master/pipeline.svg)](https://gitlab.com/JuliaGPU/GeometricFlux-jl/commits/master)

docs/Project.toml

@@ -1,2 +1,5 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "0.24"

docs/make.jl

@@ -5,12 +5,13 @@ makedocs(
     sitename = "GeometricFlux",
     format = Documenter.HTML(),
     modules = [GeometricFlux],
-    analytics = "",
     pages = ["Home" => "index.md",
              "Manual" =>
                ["Convolutional Layers" => "manual/conv.md",
                 "Pooling Layers" => "manual/pool.md",
-                "Models" => "manual/models.md"]
+                "Models" => "manual/models.md",
+                "Linear Algebra" => "manual/linalg.md",
+                "Utilities" => "manual/utils.md"]
     ]
 )
 

docs/src/manual/linalg.md

@@ -0,0 +1,6 @@
+# Linear Algebra
+
+
+```@docs
+GeometricFlux.degrees
+```

docs/src/manual/utils.md

@@ -0,0 +1,5 @@
+# Utilities
+
+```@docs
+GeometricFlux.save_div
+```

src/linalg.jl

@@ -12,6 +12,8 @@ Degree of each vertex. Return a vector which contains the degree of each vertex
 
 # Examples
 ```jldoctest
+julia> using GeometricFlux
+
 julia> m = [0 1 1; 1 0 0; 1 0 0];
 
 julia> GeometricFlux.degrees(m)

src/utils.jl

@@ -49,6 +49,8 @@ end
 identity(; kwargs...) = kwargs.data
 
 """
+    save_div(x, y)
+
 Savely divde `x` by `y`. If `y` is zero, return `x` directly.
 """
 save_div(x, y) = ifelse(iszero(y), x, x/y)