Documentation improvements. (#445)

astronomy-commons · Dec 20, 2024 · 171b901 · 171b901
1 parent 0cd372a
commit 171b901
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 4 deletions.
diff --git 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
@@ -33,7 +33,7 @@ The latest release version of HATS is available to install with `pip <https://py
                 pyenv virtualenv 3.11 hats_env
                 pyenv local hats_env
 
-    We recommend Python versions **>=3.9, <=3.12**.
+    We recommend Python versions **>=3.10, <=3.12**.
 
 HATS can also be installed from source on `GitHub <https://github.com/astronomy-commons/hats>`_.
 

diff --git 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
 <https://github.com/astronomy-commons/lsdb>`_ 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<getting_started>`
+interested in using just the HATS package, you can find installation instructions at the 
+:doc:`getting started page</getting_started>`.
 
 Acknowledgements
 -------------------------------------------------------------------------------

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -8,3 +8,4 @@ sphinx
 sphinx-autoapi
 sphinx-copybutton
 sphinx-book-theme
+sphinx-design
diff --git 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