diff --git a/.travis.yml b/.travis.yml index 002de00..d4caebb 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,6 +6,16 @@ julia: - 1.0 - 1.1 - nightly +jobs: + include: + - stage: "Documentation" + julia: 1.0 + os: linux + script: + - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); + Pkg.instantiate()' + - julia --project=docs/ docs/make.jl + after_success: skip notifications: email: false branches: diff --git a/README.md b/README.md index 020e439..23a1c9b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Meshing +[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaGeometry.github.io/Meshing.jl/stable) +[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaGeometry.github.io/Meshing.jl/dev) + [![Build Status](https://travis-ci.org/JuliaGeometry/Meshing.jl.svg)](https://travis-ci.org/JuliaGeometry/Meshing.jl) [![codecov.io](http://codecov.io/github/JuliaGeometry/Meshing.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaGeometry/Meshing.jl?branch=master) diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..a303fff --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +build/ +site/ diff --git a/docs/Project.toml b/docs/Project.toml new file mode 100644 index 0000000..2ccde02 --- /dev/null +++ b/docs/Project.toml @@ -0,0 +1,5 @@ +[deps] +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" + +[compat] +Documenter = "~0.23" \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..9eebdfc --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,13 @@ +using Documenter +using Meshing + +makedocs( + sitename = "Meshing", + format = Documenter.HTML(), + modules = [Meshing], + pages = ["Internals" => "internals.md"] +) + +deploydocs( + repo = "github.com/JuliaGeometry/Meshing.jl.git", +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..9910022 --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,9 @@ +# Meshing.jl + +Documentation for Meshing.jl + +```@docs + +marching_cubes() + +``` \ No newline at end of file diff --git a/docs/src/internals.md b/docs/src/internals.md new file mode 100644 index 0000000..44b8e45 --- /dev/null +++ b/docs/src/internals.md @@ -0,0 +1,11 @@ +# Internals + +## Marching Cubes + + + +## Marching Tetrahedra + + + +## Surface Nets \ No newline at end of file