From b52b202272747135de5a6ffecad0f439e0f91ac9 Mon Sep 17 00:00:00 2001 From: Helge Eichhorn Date: Mon, 13 Mar 2017 19:55:18 +0100 Subject: [PATCH] Setup docs. --- .gitignore | 1 + .travis.yml | 4 +++- README.md | 3 +++ .../logo.png} | Bin docs/make.jl | 17 +++++++++++++++++ docs/src/index.md | 0 6 files changed, 24 insertions(+), 1 deletion(-) rename docs/{logo/Astrodynamics-jl-logo.png => assets/logo.png} (100%) create mode 100644 docs/make.jl create mode 100644 docs/src/index.md diff --git a/.gitignore b/.gitignore index f76024e..610364e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ data/ .DS_Store ._.DS_Store +docs/build/ diff --git a/.travis.yml b/.travis.yml index 0446598..407cf84 100644 --- a/.travis.yml +++ b/.travis.yml @@ -26,4 +26,6 @@ script: - julia -e 'Pkg.clone(pwd()); Pkg.build("Astrodynamics"); Pkg.test("Astrodynamics"; coverage=true)' after_success: - - julia -e 'cd(Pkg.dir("Astrodynamics")); Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder()) + - julia -e 'Pkg.add("Documenter")' + - julia -e 'cd(Pkg.dir("Astrodynamics")); include(joinpath("docs", "make.jl"))' + - julia -e 'cd(Pkg.dir("Astrodynamics")); Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())' diff --git a/README.md b/README.md index f16a2c1..ade640e 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,6 @@ Pkg.clone("https://github.com/JuliaAstrodynamics/AstroDynModels.jl.git") Pkg.clone("https://github.com/JuliaAstrodynamics/AstroDynPlots.jl.git") Pkg.clone("https://github.com/JuliaAstrodynamics/Astrodynamics.jl.git") ``` + +[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaastrodynamics.github.io/Astrodynamics.jl/stable) +[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliaastrodynamics.github.io/Astrodynamics.jl/latest) diff --git a/docs/logo/Astrodynamics-jl-logo.png b/docs/assets/logo.png similarity index 100% rename from docs/logo/Astrodynamics-jl-logo.png rename to docs/assets/logo.png diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..375f90e --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,17 @@ +using Documenter, Astrodynamics + +makedocs( + format = :html, + sitename = "Astrodynamics.jl", + authors = "Helge Eichhorn", + pages = [ + "Home" => "index.md", + ], +) + +deploydocs( + repo = "github.com/JuliaAstrodynamics/Astrodynamics.jl.git", + target = "build", + deps = nothing, + make = nothing, +) diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..e69de29