Skip to content

Commit 0d2b6ab

Browse files
author
LuizFCDuarte
committed
📝 Create docs skeleton
1 parent 58816e7 commit 0d2b6ab

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

docs/Project.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using Documenter
2+
include("../src/Sarimax.jl")
3+
4+
DocMeta.setdocmeta!(Sarimax, :DocTestSetup, :(using Sarimax); recursive=true)
5+
6+
makedocs(;
7+
modules=[Sarimax],
8+
doctest=true,
9+
clean=true,
10+
checkdocs=:none,
11+
format=Documenter.HTML(; mathengine=Documenter.MathJax2()),
12+
sitename="SARIMAX.jl",
13+
authors="Luiz Fernando Duarte",
14+
pages=[
15+
"Home" => "index.md",
16+
],
17+
)
18+
19+
deploydocs(; repo="github.com/LAMPSPUC/SARIMAX.jl.git", push_preview=true)

docs/src/index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
```raw html
2+
<!-- Ensure that raw HTML is properly formatted -->
3+
<div style="width:100%; height:150px;border-width:4px;border-style:solid;padding-top:25px;
4+
border-color:#000;border-radius:10px;text-align:center;background-color:#99DDFF;
5+
color:#000">
6+
<h3 style="color: black;">Star us on GitHub!</h3>
7+
<a class="github-button" href="https://github.com/LAMPSPUC/SARIMAX.jl" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star LAMPSPUC/SARIMAX.jl on GitHub" style="margin:auto">Star</a>
8+
<script async defer src="https://buttons.github.io/buttons.js"></script>
9+
</div>
10+
```
11+
12+
# Sarimax.jl
13+
14+
## Installation
15+
16+
This package is registered so you can simply `add` it using Julia's `Pkg` manager:
17+
```julia
18+
using Pkg
19+
Pkg.add("SARIMAX")
20+
```

0 commit comments

Comments
 (0)