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

Documentation improvements. #445

Merged
merged 1 commit into from
Dec 20, 2024
+11 −4
Merged

Documentation improvements. #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.

Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ sphinx
sphinx-autoapi
sphinx-copybutton
sphinx-book-theme
sphinx-design
2 changes: 1 addition & 1 deletion src/hats/io/parquet_metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,5 +276,5 @@ def aggregate_column_statistics(
"max_value": stats_lists[1],
"null_count": stats_lists[2],
}
)
).set_index("column_names")
return frame
Loading