Merge pull request #12 from JuliaAstro/icweaver-canonize

Canonize

Author: icweaver

README.md

@@ -1,13 +1,13 @@
 # Orbits.jl
 
-[![Build Status](https://github.com/juliaastro/Orbits.jl/workflows/CI/badge.svg?branch=main)](https://github.com/juliaastro/Orbits.jl/actions)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaastro.github.io/Orbits/stable/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaastro.github.io/Orbits.jl/dev/)
+
+[![CI](https://github.com/JuliaAstro/Orbits.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/JuliaAstro/Orbits.jl/actions/workflows/ci.yml)
 [![PkgEval](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/O/Orbits.svg)](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/report.html)
-[![Coverage](https://codecov.io/gh/juliaastro/Orbits.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/juliaastro/Orbits.jl)
+[![codecov](https://codecov.io/gh/juliaastro/Orbits.jl/graph/badge.svg?token=0PXylAA9Ig)](https://codecov.io/gh/juliaastro/Orbits.jl)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaastro.github.io/Orbits.jl/stable)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaastro.github.io/Orbits.jl/dev)
-
 Flexible and fast astronomical orbits (originally a submodule of [Transits.jl](https://github.com/JuliaAstro/Transits.jl)).
 
 The goals of this package are, in this order:

docs/make.jl

@@ -1,5 +1,6 @@
 using Orbits
 using Documenter
+using Documenter.Remotes: GitHub
 
 setup = quote
     using Orbits
@@ -10,16 +11,19 @@ DocMeta.setdocmeta!(Orbits, :DocTestSetup, setup; recursive=true)
 include("pages.jl")
 
 makedocs(;
-    modules=[Orbits],
-    authors="Miles Lucas <[email protected]> and contributors",
-    repo="https://github.com/juliaastro/Orbits.jl/blob/{commit}{path}#L{line}",
-    sitename="Orbits.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://juliaastro.github.io/Orbits.jl",
-        assets=String[],
+    modules = [Orbits],
+    authors = "Miles Lucas <[email protected]> and contributors",
+    repo = GitHub("https://github.com/juliaAstro/Orbits.jl"),
+    sitename = "Orbits.jl",
+    format = Documenter.HTML(;
+        prettyurls = get(ENV, "CI", "false") == "true",
+        canonical = "https://juliaastro.org/Orbits/stable/",
     ),
     pages=pages,
 )
 
-deploydocs(; repo="github.com/JuliaAstro/Orbits.jl", push_preview=true, devbranch="main")
+deploydocs(;
+    repo = "github.com/JuliaAstro/Orbits.jl.git",
+    push_preview = true,
+    versions = ["stable" => "v^", "v#.#"], # Restrict to minor releases
+)

docs/src/index.md

@@ -5,9 +5,9 @@ CurrentModule = Orbits
 # Orbits.jl
 
 [![GitHub](https://img.shields.io/badge/Code-GitHub-black.svg)](https://github.com/juliaastro/Orbits.jl)
-[![Build Status](https://github.com/juliaastro/Orbits.jl/workflows/CI/badge.svg?branch=main)](https://github.com/juliaastro/Orbits.jl/actions)
+[![CI](https://github.com/JuliaAstro/Orbits.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/JuliaAstro/Orbits.jl/actions/workflows/ci.yml)
 [![PkgEval](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/O/Orbits.svg)](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/report.html)
-[![Coverage](https://codecov.io/gh/juliaastro/Orbits.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/juliaastro/Orbits.jl)
+[![codecov](https://codecov.io/gh/juliaastro/Orbits.jl/graph/badge.svg?token=0PXylAA9Ig)](https://codecov.io/gh/juliaastro/Orbits.jl)
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaastro.github.io/Orbits.jl/stable)