Modernise documentation (#38)

ratt-ru · Apr 15, 2024 · 47a0142 · 47a0142
1 parent ca06461
commit 47a0142
Show file tree

Hide file tree

Showing 27 changed files with 304 additions and 419 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -13,3 +13,8 @@ repos:
     hooks:
     -   id: ruff-format
         name: ruff format
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+    -   id: mypy
+        name: mypy
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,15 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+
+sphinx:
+  configuration: docs/source/conf.py
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -4,6 +4,7 @@ History
 
 X.Y.Z (YYYY-MM-DD)
 ------------------
+* Modernise documentation (:pr:`38`)
 * Add basic Affine Grid coordinates to xarray datasets (:pr:`35`)
 * Constrain dask versions (:pr:`34`)
 * Specify dtype during chunk normalisation (:pr:`33`)

diff --git a/README.rst b/README.rst
@@ -2,53 +2,4 @@
 xarray-fits
 ===========
 
-Given some FITS files with matching HDUs:
-
-.. code-block:: bash
-
-  $ tree data
-  /home/user/data
-  ├── data-0.fits
-  ├── data-1.fits
-  └── data-2.fits
-
-  0 directories, 3 files
-
-.. code-block:: python
-
-  >>> from xarrayfits import xds_from_fits
-  >>> datasets = xds_from_fits("/home/user/data*", prefix="data")
-
-The above returns a list of three xarray Datasets
-
-.. code-block:: python
-
-  >>> datasets
-  [<xarray.Dataset> Size: 800B
-   Dimensions:  (data0-0: 10, data0-1: 10)
-   Dimensions without coordinates: data0-0, data0-1
-   Data variables:
-       data0    (data0-0, data0-1) float64 800B dask.array<chunksize=(10, 10), meta=np.ndarray>,
-   <xarray.Dataset> Size: 800B
-   Dimensions:  (data0-0: 10, data0-1: 10)
-   Dimensions without coordinates: data0-0, data0-1
-   Data variables:
-       data0    (data0-0, data0-1) float64 800B dask.array<chunksize=(10, 10), meta=np.ndarray>,
-   <xarray.Dataset> Size: 800B
-   Dimensions:  (data0-0: 10, data0-1: 10)
-   Dimensions without coordinates: data0-0, data0-1
-   Data variables:
-       data0    (data0-0, data0-1) float64 800B dask.array<chunksize=(10, 10), meta=np.ndarray>]
-
-Using xarray these can be concatenated along a dimension:
-
-  .. code-block:: python
-
-    >>> import xarray
-    >>> ds = xarray.concat(datasets, dim="data0-0")
-    >>> ds
-    <xarray.Dataset> Size: 2kB
-    Dimensions:  (data0-0: 30, data0-1: 10)
-    Dimensions without coordinates: data0-0, data0-1
-    Data variables:
-        data0    (data0-0, data0-1) float64 2kB dask.array<chunksize=(10, 10), meta=np.ndarray>
+Documentation: https://xarray-fits.readthedocs.io
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,12 +1,12 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = python -msphinx
-SPHINXPROJ    = xarrayfits
-SOURCEDIR     = .
-BUILDDIR      = _build
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/history.rst b/docs/history.rst
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/installation.rst b/docs/installation.rst