Skip to content

Commit

Permalink
Improve docs with styling and more content (#102)
Browse files Browse the repository at this point in the history
* Add styling and more content

* Finish beautifying docs
  • Loading branch information
skygering authored Aug 6, 2024
1 parent dcf463a commit ee2c933
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ makedocs(;
deploy_url = "Caltech-OCTO.github.io/Subzero.jl",
),
pages=[
"Home" => "index.md",
"Introduction" => "introduction.md",
"API Reference" => "api.md",
],
warnonly = true,
)

deploydocs(;
repo="https://github.com/Caltech-OCTO/Subzero.jl",
push_preview=true,
)
18 changes: 18 additions & 0 deletions docs/src/api.md
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]
```
42 changes: 37 additions & 5 deletions docs/src/index.md
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>
```
3 changes: 3 additions & 0 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Introduction

## Main concepts

0 comments on commit ee2c933

Please sign in to comment.