Skip to content

Commit

Permalink
docs: Update
Browse files Browse the repository at this point in the history
  • Loading branch information
pmav99 committed May 29, 2024
1 parent 3bdef78 commit be044a9
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 26 deletions.
22 changes: 16 additions & 6 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@
# Reference
# API Reference

::: thalassa
## High level API

<!-- ::: thalassa.api -->
::: thalassa.open_dataset
::: thalassa.normalize
::: thalassa.plot
::: thalassa.plot_mesh
::: thalassa.plot_nodes
::: thalassa.plot_ts
::: thalassa.crop

<!-- ::: thalassa.utils -->
<!---->
<!-- ::: thalassa.normalization -->
## Low level API

::: thalassa.api.create_trimesh
::: thalassa.api.get_tiles
::: thalassa.api.get_nodes
::: thalassa.api.get_wireframe
::: thalassa.api.get_raster
39 changes: 19 additions & 20 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
---

site_name: "Thalassa"
use_directory_urls: false
repo_url: "https://github.com/ec-jrc/thalassa"

theme:
name: "material"
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: blue
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: blue
toggle:
icon: material/lightbulb
name: "Switch to light mode"
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: blue
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: blue
toggle:
icon: material/lightbulb
name: "Switch to light mode"

nav:
- Overview : index.md
- Installation : installation.md
- Overview: index.md
- Installation: installation.md
- Development: development.md
- API : api.md
- API: api.md

markdown_extensions:
- "admonition"
Expand Down Expand Up @@ -63,7 +62,7 @@ plugins:

### Headings
# The initial heading level to use. Default: 2.
heading_level: 2
heading_level: 3
# Show the heading of the object at the root of the documentation tree (i.e. the object referenced by the identifier after :::). Default: False.
show_root_heading: True
# If the root heading is not shown, at least add a ToC entry for it. Default: True.
Expand All @@ -78,7 +77,7 @@ plugins:
show_category_heading: False
# Show the symbol type in headings (e.g. mod, class, meth, func and attr). Default: False.
show_symbol_type_heading: False
# Show the symbol type in the Table of Contents (e.g. mod, class, methd, func and attr). Default: False
# Show the symbol type in the Table of Contents (e.g. mod, class, method, func and attr). Default: False
show_symbol_type_toc: False

### Members
Expand Down

0 comments on commit be044a9

Please sign in to comment.