tupdate documentation - Granular.jl - Julia package for granular dynamics simul… | |
git clone git://src.adamsgaard.dk/Granular.jl | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit dc7c2adf27c344488e2239eabcd129c4927c14c4 | |
parent 6d3999f0b4174870c54c13ba602d7c0fa8017c61 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Mon, 11 Sep 2017 11:32:33 -0400 | |
update documentation | |
Diffstat: | |
M docs/src/index.md | 9 ++------- | |
M docs/src/lib/internals.md | 3 ++- | |
M docs/src/lib/public.md | 6 +++--- | |
M docs/src/man/installation.md | 5 ++--- | |
4 files changed, 9 insertions(+), 14 deletions(-) | |
--- | |
diff --git a/docs/src/index.md b/docs/src/index.md | |
t@@ -6,7 +6,7 @@ | |
Flexible and computationally efficient 2d implementation of the discrete eleme… | |
-See the [Index](@ref main-index) for the complete list of documented functions… | |
+See the [Public API Index](@ref main-index) for the complete list of documente… | |
--- | |
t@@ -30,11 +30,6 @@ Depth = 1 | |
Pages = [ | |
"lib/public.md", | |
"lib/internals.md", | |
+Depth = 1 | |
] | |
``` | |
- | |
-### [Index](@id main-index) | |
- | |
-```@index | |
-Pages = ["lib/public.md"] | |
-``` | |
diff --git a/docs/src/lib/internals.md b/docs/src/lib/internals.md | |
t@@ -1,4 +1,4 @@ | |
-## Internal Documentation | |
+# Package-internal Documentation | |
This page lists all the documented internals of the `SeaIce` module. | |
t@@ -14,6 +14,7 @@ A list of all internal documentation sorted by module. | |
Pages = ["internals.md"] | |
``` | |
+## Internal Interface | |
```@autodocs | |
Modules = [SeaIce] | |
Public = false | |
diff --git a/docs/src/lib/public.md b/docs/src/lib/public.md | |
t@@ -1,15 +1,15 @@ | |
-## Public Documentation | |
+# Public API Documentation | |
Documentation for `SeaIce.jl`'s public interface. | |
-See [Internal Documentation](@ref) for itnernal package docs. | |
+See [Internal Documentation](@ref) for internal package docs. | |
## Contents | |
```@contents | |
Pages = ["public.md"] | |
``` | |
-## Index | |
+## Index(@id main-index) | |
```@index | |
Pages = ["public.md"] | |
``` | |
diff --git a/docs/src/man/installation.md b/docs/src/man/installation.md | |
t@@ -4,9 +4,8 @@ SeaIce.jl can be installed directly from the Julia shell by: | |
Pkg.clone("git://github.com/anders-dc/SeaIce.jl.git") | |
This will install the contents of this repository in the folder | |
-`~/.julia/v$(JULIA_VERSION)/SeaIce`, and install the packages specified as | |
-[requirements](REQUIRE). The package [JLD](https://github.com/JuliaIO/JLD.jl) | |
-is used for model restarts and is recommended but not required, and thus is no… | |
+`~/.julia/v$(JULIA_VERSION)/SeaIce` and install its requirements. The package… | |
+is used for model restarts and is recommended but not required, and is thus no… | |
automatically installed. | |
Import the package contents into the current Julia session or script with: |