From 171b9019b8ecd082f1671eecdb93a8ab3509925f Mon Sep 17 00:00:00 2001 From: Melissa DeLucchi <113376043+delucchi-cmu@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:56:41 -0500 Subject: [PATCH] Documentation improvements. (#445) --- docs/conf.py | 7 ++++++- docs/getting_started.rst | 2 +- docs/index.rst | 3 ++- docs/requirements.txt | 1 + src/hats/io/parquet_metadata.py | 2 +- 5 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 9ec5d6ab..e33299d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,12 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = ["sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinx.ext.viewcode"] +extensions = [ + "sphinx.ext.mathjax", + "sphinx.ext.napoleon", + "sphinx.ext.viewcode", + "sphinx_design", +] extensions.append("autoapi.extension") extensions.append("nbsphinx") diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 61507ae5..924ed43e 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -33,7 +33,7 @@ The latest release version of HATS is available to install with `pip =3.9, <=3.12**. + We recommend Python versions **>=3.10, <=3.12**. HATS can also be installed from source on `GitHub `_. diff --git a/docs/index.rst b/docs/index.rst index 8f43a115..39ecf4e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,7 +44,8 @@ Getting Started For the most part, we recommend accessing and processing HATS data using the `LSDB package `_ framework. LSDB provides a variety of utility functions as well as a lazy, distributed execution framework using Dask. However if you are are -interested in using just the HATS package, you can find installation instructions at the :ref:`getting started page` +interested in using just the HATS package, you can find installation instructions at the +:doc:`getting started page`. Acknowledgements ------------------------------------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index b5ae1918..82aee704 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -8,3 +8,4 @@ sphinx sphinx-autoapi sphinx-copybutton sphinx-book-theme +sphinx-design \ No newline at end of file diff --git a/src/hats/io/parquet_metadata.py b/src/hats/io/parquet_metadata.py index ea42aaca..3b1f4ece 100644 --- a/src/hats/io/parquet_metadata.py +++ b/src/hats/io/parquet_metadata.py @@ -276,5 +276,5 @@ def aggregate_column_statistics( "max_value": stats_lists[1], "null_count": stats_lists[2], } - ) + ).set_index("column_names") return frame