Skip to content

Commit d8f12d4

Browse files
committed
setup docs/ folder along with skeleton for documentation.
1 parent 032452e commit d8f12d4

File tree

4 files changed

+58
-0
lines changed

4 files changed

+58
-0
lines changed

docs/Project.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
LabelledArrays = "2ee39098-c373-598a-b85f-a56591580800"
4+
5+
[compat]
6+
Documenter = "0.27"

docs/make.jl

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using Documenter, LabelledArrays
2+
3+
include("pages.jl")
4+
5+
makedocs(
6+
sitename="LabelledArrays.jl",
7+
authors="Chris Rackauckas",
8+
modules=[LabelledArrays],
9+
clean=true,doctest=false,
10+
format = Documenter.HTML(analytics = "UA-90474609-3",
11+
assets = ["assets/favicon.ico"],
12+
canonical="https://labelledarrays.sciml.ai/stable/"),
13+
pages=pages
14+
)
15+
16+
deploydocs(
17+
repo = "github.com/SciML/LabelledArrays.jl.git";
18+
push_preview = true
19+
)

docs/pages.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Put in a separate page so it can be used by SciMLDocs.jl
2+
3+
pages=[
4+
"Home" => "index.md",
5+
"array_types.md",
6+
"recursive_array_functions.md"
7+
]

docs/src/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# LabelledArrays.jl: Arrays with Label Goodness
2+
3+
LabelledArrays.jl is a package which provides arrays with labels, i.e. they are
4+
arrays which `map`, `broadcast`, and all of that good stuff, but their components
5+
are labelled. Thus for instance you can set that the second component is named
6+
`:second` and retrieve it with `A.second`.
7+
8+
## Installation
9+
10+
To install LabelledArrays.jl, use the Julia package manager:
11+
12+
```julia
13+
using Pkg
14+
Pkg.add("LabelledArrays")
15+
```
16+
17+
## Contributing
18+
19+
- Please refer to the
20+
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
21+
for guidance on PRs, issues, and other matters relating to contributing to SciML.
22+
- There are a few community forums:
23+
- the #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/)
24+
- [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter
25+
- on the [Julia Discourse forums](https://discourse.julialang.org)
26+
- see also [SciML Community page](https://sciml.ai/community/)

0 commit comments

Comments
 (0)