Merge pull request #20 from AugustinMortier/0.8.2

work on documentation
AugustinMortier · Sep 24, 2024 · 074cc86 · 074cc86
2 parents 349ec0c + af4fa56
commit 074cc86
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 12 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -1,13 +1,15 @@
 # Overview
 
-:material-api:
+:material-api:{ style="text-align: center; font-size: xx-large; display: block" }
 
 Documentation of the core API of [aprofiles](index.md).
 
-- [Reading](api/reading.md)
-- [Data Classes](api/data_classes.md)
-- [Detection](api/detection.md)
-- [Retrieval](api/retrieval.md)
-- [Simulation](api/simulation.md)
-- [Plotting](api/plotting.md)
-- [Writing](api/writing.md)
+<div class="grid cards" markdown>
+- [:material-book-open-variant: Reading](api/reading.md)
+- [:material-database: Data Classes](api/data_classes.md)
+- [:material-eye: Detection](api/detection.md)
+- [:material-pencil-box-multiple-outline: Retrieval](api/retrieval.md)
+- [:material-laptop: Simulation](api/simulation.md)
+- [:material-chart-scatter-plot: Plotting](api/plotting.md)
+- [:material-file-send: Writing](api/writing.md)
+</div>
diff --git a/docs/api/data_classes.md b/docs/api/data_classes.md
@@ -1,5 +1,7 @@
 # Data Classes
 
+:material-database:{ style="text-align: center; font-size: xx-large; display: block" }
+
 ## ProfilesData
 
 The [`ProfilesData`](#profilesdata) class contains profile data information. Most of the information can be found in the `data` attribute, which is an [`xarray.Dataset`](https://xarray.pydata.org/en/stable/generated/xarray.Dataset.html). Detection and retrieval methods might add information as additional [`xarray.DataArray`](https://xarray.pydata.org/en/stable/generated/xarray.DataArray.html).

diff --git a/docs/api/detection.md b/docs/api/detection.md
@@ -1,5 +1,7 @@
 # Detection
 
+:material-eye:{ style="text-align: center; font-size: xx-large; display: block" }
+
 The following functions are methods from the class [`ProfilesData`](../data_classes/#profilesdata).
 
 ## Fog or Condensation

diff --git a/docs/api/plotting.md b/docs/api/plotting.md
@@ -1,5 +1,7 @@
 # Plotting
 
+:material-chart-scatter-plot:{ style="text-align: center; font-size: xx-large; display: block" }
+
 ## Image
 
 This module is used to plot an image (time, altitude) for a given variable of an instance of the [`ProfilesData`](../data_classes/#profilesdata) class.

diff --git a/docs/api/reading.md b/docs/api/reading.md
@@ -1,5 +1,7 @@
 # Reading
 
+:material-book-open-variant:{ style="text-align: center; font-size: xx-large; display: block" }
+
 The [`Reader`](#aprofiles.reader) module includes classes for reading profiles (NetCDF) and Aeronet (txt) data.
 
 ::: aprofiles.reader
diff --git a/docs/api/retrieval.md b/docs/api/retrieval.md
@@ -1,5 +1,7 @@
 # Retrieval
 
+:material-pencil-box-multiple-outline:{ style="text-align: center; font-size: xx-large; display: block" }
+
 The following functions are methods from the class
 [`ProfilesData`](../data_classes/#profilesdata)
 

diff --git a/docs/api/simulation.md b/docs/api/simulation.md
@@ -1,5 +1,7 @@
 # Simulation
 
+:material-laptop:{ style="text-align: center; font-size: xx-large; display: block" }
+
 This module is used to calculate attenuated backscatter profiles from
 extinction profiles given a predefined atmospheric model.
 

diff --git a/docs/api/writing.md b/docs/api/writing.md
@@ -1,5 +1,7 @@
 # Writing
 
+:material-file-send:{ style="text-align: center; font-size: xx-large; display: block; }
+
 This module is used to write data from an instance of the [`ProfilesData`](../data_classes/#profilesdata) class as a NetCDF file.
 
 ::: aprofiles.io.write_profiles
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,6 +1,6 @@
 # Changelog
 
-:material-history:
+:material-history:{ style="text-align: center; font-size: xx-large; display: block" }
 
 ## 0.8.1
 Sep 24, 2024

diff --git a/docs/cli.md b/docs/cli.md
@@ -1,6 +1,6 @@
 # CLI
 
-:material-keyboard:
+:material-keyboard:{ style="text-align: center; font-size: xx-large; display: block" }
 
 For facilitating the processing of the measurements in routine, a
 Command Line Interface (CLI) has been developed:

diff --git a/docs/examples.md b/docs/examples.md
@@ -1,6 +1,6 @@
 # Examples
 
-:simple-rocket:
+:simple-rocket:{ style="text-align: center; font-size: xx-large; display: block" }
 
 Some basic examples for getting you started using *aprofiles*. For more
 information, check out the `API`{.interpreted-text role="ref"}.

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,6 +1,6 @@
 # Installation
 
-:fontawesome-brands-python:
+:fontawesome-brands-python:{ style="text-align: center; font-size: xx-large; display: block" }
 
 ## :simple-pipx: via *pip/pipx*