Merge pull request #65 from abhro/patch-1

Documentation segmenting/sectioning

contrib/generate_exports.jl

@@ -18,8 +18,8 @@ sources = first.(splitext.(filter(x->!startswith(x, "t_") && !startswith(x, "erf
 exports = "export " * join(sources, ", ")
 
 open(OUTPUT, "w") do f
-	println(f, "# Auto-generated by $(joinpath(basename(@__DIR__()), basename(@__FILE__))). Do not edit!\n")
-	println(f, exports)
+    println(f, "# Auto-generated by $(joinpath(basename(@__DIR__()), basename(@__FILE__))). Do not edit!\n")
+    println(f, exports)
 end
 
 format(OUTPUT, BlueStyle())

docs/make.jl

@@ -2,14 +2,17 @@ using Documenter, ERFA
 
 include("pages.jl")
 
-makedocs(format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true",
+makedocs(
+    format = Documenter.HTML(
+        prettyurls = get(ENV, "CI", nothing) == "true",
     ),
     sitename = "ERFA.jl",
     authors = "The JuliaAstro Contributors",
     pages = pages,
-    doctest = false,
+    doctest = true,
 )
 
-deploydocs(repo = "github.com/JuliaAstro/ERFA.jl.git",
+deploydocs(
+    repo = "github.com/JuliaAstro/ERFA.jl.git",
     target = "build",
 )

docs/src/api.md

@@ -6,7 +6,44 @@ DocTestSetup = quote
 end
 ```
 
+## Constants
+
+```@autodocs
+Modules = [ERFA]
+Private = true
+Order = [:constant]
+```
+
+## Types
+
+```@autodocs
+Modules = [ERFA]
+Private = true
+Order = [:type]
+```
+
+## Functions
+
 ```@autodocs
 Modules = [ERFA]
 Private = true
+Order = [:function, :macro]
+```
+
+## Index
+
+### Constants
+
+```@index
+Modules = [ERFA]
+Private = true
+Order = [:constant]
+```
+
+### Functions
+
+```@index
+Modules = [ERFA]
+Private = true
+Order = [:function, :macro]
 ```

docs/src/index.md

@@ -6,14 +6,14 @@ Julia wrapper for [liberfa](https://github.com/liberfa/erfa).
 Installation
 ------------
 
-```julia
+```julia-repl
 julia> import Pkg; Pkg.add("ERFA")
 ```
 
 Example
 -------
 
-```julia
+```jldoctest
 julia> using ERFA
 
 julia> u1, u2 = dtf2d("UTC", 2010, 7, 24, 11, 18, 7.318)