-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve docs with styling and more content (#102)
* Add styling and more content * Finish beautifying docs
- Loading branch information
Showing
4 changed files
with
60 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
```@meta | ||
CurrentModule = Subzero | ||
``` | ||
|
||
# Full Subzero API documentation | ||
|
||
!!! warning | ||
This page is still very much WIP! | ||
|
||
Documentation for [Subzero](https://github.com/Caltech-OCTO/Subzero.jl)'s full API (only for reference!). | ||
|
||
```@index | ||
``` | ||
|
||
## All methods | ||
```@autodocs | ||
Modules = [Subzero] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,39 @@ | ||
# Subzero.jl | ||
```@raw html | ||
--- | ||
# https://vitepress.dev/reference/default-theme-home-page | ||
layout: home | ||
Documentation for `Subzero.jl`. | ||
hero: | ||
name: "Subzero.jl" | ||
text: "" | ||
tagline: Fast and Flexible Sea Ice Dynamics | ||
actions: | ||
- theme: brand | ||
text: Introduction | ||
link: /introduction | ||
- theme: alt | ||
text: API Reference | ||
link: /api | ||
- theme: alt | ||
text: View on Github | ||
link: https://github.com/Caltech-OCTO/Subzero.jl | ||
```@autodocs | ||
Modules=[Subzero] | ||
``` | ||
features: | ||
- icon: <img width="64" height="64" src="https://rawcdn.githack.com/JuliaLang/julia-logo-graphics/f3a09eb033b653970c5b8412e7755e3c7d78db9e/images/juliadots.iconset/icon_512x512.png" alt="Julia code"/> | ||
title: Pure Julia code | ||
details: Fast, understandable, extensible functions | ||
link: "https://julialang.org/" | ||
- icon: <img width="64" height="64" src="https://fredrikekre.github.io/Literate.jl/v2/assets/logo.png" /> | ||
title: Literate programming | ||
details: Documented source code with examples! | ||
link: "https://github.com/fredrikekre/Literate.jl" | ||
--- | ||
<p style="margin-bottom:2cm"></p> | ||
<div class="vp-doc" style="width:80%; margin:auto"> | ||
# What is Subzero.jl? | ||
</div> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Introduction | ||
|
||
## Main concepts |