Skip to content

Commit

Permalink
Improve readability of documentation (#632)
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Vo <tomvothecoder@gmail.com>
  • Loading branch information
pochedls and tomvothecoder authored Apr 10, 2024
1 parent 1f4d22a commit 65c0be6
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 18 deletions.
Binary file added docs/_static/icons/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/faq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/icons/wrench.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/gallery.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
- title: A Gentle Introduction to xCDAT (Xarray Climate Data Analysis Tools)
- title: Introduction to xCDAT
path: examples/introduction-to-xcdat.ipynb
thumbnail: _static/xcdat-logo.png

- title: General Dataset Utilities
- title: xCDAT Utilities
path: examples/general-utilities.ipynb
thumbnail: _static/dataset-diagram.webp

- title: Calculate Geospatial Weighted Averages from Monthly Time Series
- title: Spatial Averaging
path: examples/spatial-average.ipynb
thumbnail: _static/thumbnails/spatial-avg.png

- title: Calculate Time Averages from Time Series Data
- title: Temporal Averaging
path: examples/temporal-average.ipynb
thumbnail: _static/thumbnails/temporal-average.png

- title: Calculate Climatology and Departures from Time Series Data
- title: Climatology and Departures
path: examples/climatology-and-departures.ipynb
thumbnail: _static/thumbnails/climatology-and-departures.png

Expand Down
23 changes: 23 additions & 0 deletions docs/getting-started-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ Getting Started

The getting started guide aims to get you using xCDAT productively as quickly as possible.

.. grid:: 1 1 2 2
:gutter: 2

.. grid-item-card:: Project Overview
:img-top: ../_static/icons/dashboard.png
:link: overview
:link-type: doc

.. grid-item-card:: Installation
:img-top: ../_static/icons/wrench.png
:link: installation
:link-type: doc

.. grid-item-card:: xCDAT on HPC / Jupyter
:img-top: ../_static/icons/server.png
:link: getting-started-hpc-jupyter
:link-type: doc

.. grid-item-card:: Frequently Asked Questions
:img-top: ../_static/icons/faq.png
:link: faqs
:link-type: doc

.. toctree::
:maxdepth: 2
:hidden:
Expand Down
13 changes: 0 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,21 @@ xCDAT (Xarray Climate Data Analysis Tools) is an extension of `xarray`_ for clim
:link: getting-started-guide/index
:link-type: doc

New to xCDAT? Check out the getting started guides.

.. grid-item-card:: Examples
:img-top: _static/icons/plot.svg
:link: gallery
:link-type: doc

This gallery demonstrates how to use some of the features in xCDAT through
Jupyter Notebooks with real-world examples.

.. grid-item-card:: API reference
:img-top: _static/icons/wrench.svg
:link: api
:link-type: doc

The reference guide contains a detailed description of the xCDAT API.
The reference describes how the methods work and which parameters can
be used. It assumes that you have an understanding of key Xarray concepts.

.. grid-item-card:: Developer guide
:img-top: _static/icons/book.svg
:link: contributing
:link-type: doc

Saw a typo in the documentation? Want to improve existing functionalities?
The contributing guidelines will guide you through the process of improving
xCDAT.


.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 65c0be6

Please sign in to comment.