Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readability of documentation #632

Merged
merged 2 commits into from
Apr 10, 2024
Merged

Improve readability of documentation #632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5373c43
Initial work on #630
pochedls Mar 29, 2024
03e271e
Merge branch 'main' into docs/630-docs-readability
tomvothecoder Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/icons/dashboard.png
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will update the notebook title, too, so that this is reflected in the table of contents link.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good

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
View file
Open in desktop
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
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I downloaded png and then noticed you used svg. I can change this (the file sizes are small either way).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding these links. .png is fine

: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
View file
Open in desktop
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.

Comment on lines -24 to -25
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just removed the text (I thought these were self-explanatory enough), but I don't object to short text descriptions.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm okay with no text

.. 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
Loading