From 6ae3f0199fa6c15bd2e12749839597acd02e51a4 Mon Sep 17 00:00:00 2001 From: Callan Gray Date: Wed, 1 Apr 2026 19:04:18 +0800 Subject: [PATCH] docs formatting Signed-off-by: Callan Gray --- .gitignore | 1 + README.md | 8 +- docs/img/astropy_xarray_logo.svg | 2944 ++++++++++++++++++++++++++++++ docs/index.rst | 7 +- docs/whats-new.rst | 2 +- 5 files changed, 2958 insertions(+), 4 deletions(-) create mode 100644 docs/img/astropy_xarray_logo.svg diff --git a/.gitignore b/.gitignore index 1ce64b54..5d7958af 100644 --- a/.gitignore +++ b/.gitignore @@ -44,6 +44,7 @@ htmlcov/ .coverage .coverage.* .cache +.ruff_cache nosetests.xml coverage.xml *.cover diff --git a/README.md b/README.md index 248e48d1..6469c7f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# astropy-xarray + [![CI](https://github.com/calgray/astropy-xarray/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/calgray/astropy-xarray/actions/workflows/ci.yml) [![code coverage](https://codecov.io/gh/calgray/astropy-xarray/branch/main/graph/badge.svg)](https://codecov.io/gh/calgray/astropy-xarray) [![docs](https://readthedocs.org/projects/astropy-xarray/badge/?version=latest)](https://astropy-xarray.readthedocs.io) @@ -5,9 +7,11 @@ [![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) [![conda-forge](https://img.shields.io/conda/vn/conda-forge/astropy-xarray)](https://github.com/conda-forge/astropy-xarray-feedstock) -# astropy-xarray +

+ +

-A convenience wrapper for using [astropy](https://www.astropy.org) with +Seamless interoperability between [astropy](https://www.astropy.org) and [xarray](https://xarray.pydata.org). ## Simple Usage diff --git a/docs/img/astropy_xarray_logo.svg b/docs/img/astropy_xarray_logo.svg new file mode 100644 index 00000000..53a51d6a --- /dev/null +++ b/docs/img/astropy_xarray_logo.svg @@ -0,0 +1,2944 @@ + + + +astropyxarray diff --git a/docs/index.rst b/docs/index.rst index 4c486052..c7d3e8f1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,11 @@ astropy-xarray ============== -A convenience wrapper for using `astropy`_ in `xarray`_ objects. + +.. image:: img/astropy_xarray_logo.svg + :align: center + :width: 50% + +Seamless interoperability between `astropy`_ and `xarray`_. .. _astropy: https://docs.astropy.org/en/latest/ .. _xarray: https://xarray.pydata.org/en/stable diff --git a/docs/whats-new.rst b/docs/whats-new.rst index e379cf51..bf7b3da8 100644 --- a/docs/whats-new.rst +++ b/docs/whats-new.rst @@ -19,7 +19,7 @@ What's new - Added :py:meth:`Dataset.astropy.to_skycoord` accessor. -By `Callan Gray `_. + By `Callan Gray `_. 0.1.0 (17 Jul 2025) -------------------