tauto-document SeaIce.jl - Granular.jl - Julia package for granular dynamics si… | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit b2a0b00aa8b315f1c86df738850d4bf493682b89 | |
parent a29784ee88782858b9eb9e6d3c76b14dbcea89df | |
Author: Anders Damsgaard <[email protected]> | |
Date: Mon, 11 Sep 2017 10:11:40 -0400 | |
auto-document SeaIce.jl | |
Diffstat: | |
M docs/make.jl | 3 ++- | |
M docs/src/index.md | 5 +++-- | |
A docs/src/module.md | 6 ++++++ | |
3 files changed, 11 insertions(+), 3 deletions(-) | |
--- | |
diff --git a/docs/make.jl b/docs/make.jl | |
t@@ -9,7 +9,8 @@ makedocs( | |
pages = Any[ # Compat: `Any` for 0.4 compat | |
"Home" => "index.md", | |
"Manual" => Any[ | |
- "installation.md" | |
+ "installation.md", | |
+ "module.md" | |
] | |
] | |
) | |
diff --git a/docs/src/index.md b/docs/src/index.md | |
t@@ -4,13 +4,14 @@ | |
## Package features | |
-Flexible and computationally efficient 2d implementation of the discrete eleme… | |
+Flexible and computationally efficient 2d implementation of the discrete eleme… | |
## Manual Outline | |
```@contents | |
Pages = [ | |
- "installation.md" | |
+ "installation.md", | |
+ "module.md" | |
] | |
Depth = 1 | |
``` | |
diff --git a/docs/src/module.md b/docs/src/module.md | |
t@@ -0,0 +1,6 @@ | |
+# Modules, constants, types, functions, and macros | |
+ | |
+```@autodocs | |
+Modules = [SeaIce] | |
+Private = false | |
+``` |