trestructure documentation, split library overview into public and internals - … | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 8017ec8c0fbb60b531e5ccd4a2e2eac696def195 | |
parent a87a8b5ac38995f1a4c571d89a127f0cf2300354 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Mon, 11 Sep 2017 10:50:03 -0400 | |
restructure documentation, split library overview into public and internals | |
Diffstat: | |
M docs/make.jl | 33 ++++++++++++++++++-----------… | |
M docs/src/index.md | 16 +++++++++++++--- | |
A docs/src/lib/internals.md | 21 +++++++++++++++++++++ | |
A docs/src/lib/public.md | 22 ++++++++++++++++++++++ | |
R docs/src/installation.md -> docs/s… | 0 | |
D docs/src/module.md | 6 ------ | |
6 files changed, 75 insertions(+), 23 deletions(-) | |
--- | |
diff --git a/docs/make.jl b/docs/make.jl | |
t@@ -2,23 +2,28 @@ using Documenter, SeaIce | |
makedocs( | |
modules = [SeaIce], | |
- clean = false, | |
- format = :html, | |
+ clean = false, | |
+ format = :html, | |
sitename = "SeaIce.jl", | |
authors = "Anders Damsgaard", | |
- pages = Any[ # Compat: `Any` for 0.4 compat | |
- "Home" => "index.md", | |
- "Manual" => Any[ | |
- "installation.md", | |
- "module.md" | |
- ] | |
- ] | |
+ pages = Any[ # Compat: `Any` for 0.4 compat | |
+ "Home" => "index.md", | |
+ "Manual" => Any[ | |
+ "man/installation.md", | |
+ ] | |
+ "Library" => Any[ | |
+ "Public" => "lib/public.md", | |
+ hide("Internals" => "lib/internals.md", Any[ | |
+ "lib/internals.md", | |
+ ]) | |
+ ] | |
+ ], | |
) | |
deploydocs( | |
- repo = "github.com/anders-dc/SeaIce.jl.git", | |
- julia = "0.6", | |
- deps = nothing, | |
- make = nothing, | |
- target = "build" | |
+ repo = "github.com/anders-dc/SeaIce.jl.git", | |
+ julia = "0.6", | |
+ deps = nothing, | |
+ make = nothing, | |
+ target = "build", | |
) | |
diff --git a/docs/src/index.md b/docs/src/index.md | |
t@@ -6,17 +6,27 @@ | |
Flexible and computationally efficient 2d implementation of the discrete eleme… | |
+See the [Index](@ref main-index) for the complete list of documented functions… | |
+ | |
## Manual Outline | |
```@contents | |
Pages = [ | |
- "installation.md", | |
- "module.md" | |
+ "man/installation.md", | |
] | |
Depth = 1 | |
``` | |
-## Index | |
+## Library Outline | |
+```@contents | |
+Pages = [ | |
+ "lib/public.md", | |
+ "lib/internals.md", | |
+] | |
+``` | |
+ | |
+### [Index](@id main-index) | |
```@index | |
+Pages = ["lib/public.md"] | |
``` | |
diff --git a/docs/src/lib/internals.md b/docs/src/lib/internals.md | |
t@@ -0,0 +1,21 @@ | |
+## Internal Documentation | |
+ | |
+This page lists all the documented internals of the `SeaIce` module. | |
+ | |
+## Contents | |
+```@contents | |
+Pages = ["internals.md"] | |
+``` | |
+ | |
+## Index | |
+A list of all internal documentation sorted by module. | |
+ | |
+```@index | |
+Pages = ["internals.md"] | |
+``` | |
+ | |
+```@autodocs | |
+Modules = [SeaIce] | |
+Public = false | |
+Private = true | |
+``` | |
diff --git a/docs/src/lib/public.md b/docs/src/lib/public.md | |
t@@ -0,0 +1,22 @@ | |
+## Public Documentation | |
+ | |
+Documentation for `SeaIce.jl`'s public interface. | |
+ | |
+See [Internal Documentation](@ref) for itnernal package docs. | |
+ | |
+## Contents | |
+```@contents | |
+Pages = ["public.md"] | |
+``` | |
+ | |
+## Index | |
+```@index | |
+Pages = ["public.md"] | |
+``` | |
+ | |
+## Public Interface | |
+```@autodocs | |
+Modules = [SeaIce] | |
+Public = true | |
+Private = false | |
+``` | |
diff --git a/docs/src/installation.md b/docs/src/man/installation.md | |
diff --git a/docs/src/module.md b/docs/src/module.md | |
t@@ -1,6 +0,0 @@ | |
-# Modules, constants, types, functions, and macros | |
- | |
-```@autodocs | |
-Modules = [SeaIce] | |
-Private = false | |
-``` |