diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e7f7c3b2..1de6eec2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -130,7 +130,7 @@ repos: "-d", # Flag for cached environment and doctrees "./docs/_build/doctrees", # Directory "-D", # Flag to override settings in conf.py - "exclude_patterns=notebooks/*", # Exclude our notebooks from pre-commit + "exclude_patterns=tutorials/*", # Exclude our notebooks from pre-commit ] # Run unit tests, verify that they pass. Note that coverage is run against # the ./src directory here because that is what will be committed. In the diff --git a/README.md b/README.md index 16193a63..d3248200 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ See related projects: [![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/astronomy-commons/lsdb?color=purple&label=Good%20first%20issues&query=is%3Aopen%20label%3A%22good%20first%20issue%22)](https://github.com/astronomy-commons/lsdb/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) -See the [contribution guide](https://lsdb.readthedocs.io/en/stable/gettingstarted/contributing.html) +See the [contribution guide](https://lsdb.readthedocs.io/en/stable/developer/contributing.html) for complete installation instructions and contribution best practices. ## Acknowledgements diff --git a/docs/Makefile b/docs/Makefile index a5622f10..8e5cc143 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= -T -E -d _build/doctrees -D language=en -EXCLUDENB ?= -D exclude_patterns="notebooks/*","_build","**.ipynb_checkpoints" +EXCLUDENB ?= -D exclude_patterns="tutorials/*","_build","**.ipynb_checkpoints" SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = ../_readthedocs/ diff --git a/docs/_static/gaia.png b/docs/_static/gaia.png new file mode 100644 index 00000000..4dbe6a44 Binary files /dev/null and b/docs/_static/gaia.png differ diff --git a/docs/contact.rst b/docs/contact.rst new file mode 100644 index 00000000..ae56c3f9 --- /dev/null +++ b/docs/contact.rst @@ -0,0 +1,12 @@ +Contact us +=============================================================================== + +We at LINCC Frameworks pride ourselves on being a friendly bunch! + +If you're encountering issues, have some gnarly dataset, have ideas for +making our products better, or pretty much anything else, reach out! + +* Open an issue in our github repo for lsdb + * https://github.com/astronomy-commons/lsdb/issues/new +* If you're on LSSTC slack, so are we! + `#lincc-frameworks-qa `_ diff --git a/docs/gettingstarted/contributing.rst b/docs/developer/contributing.rst similarity index 100% rename from docs/gettingstarted/contributing.rst rename to docs/developer/contributing.rst diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst deleted file mode 100644 index 0d5dde47..00000000 --- a/docs/gettingstarted.rst +++ /dev/null @@ -1,12 +0,0 @@ -Getting Started -======================================================================================== - -These pages will help you install and learn the basics of using LSDB. If you encounter any issues -we encourage you to open an issue on the -`LSDB github repository `_. - -.. toctree:: - - Installing LSDB - Quickstart Guide - Contribution Guide diff --git a/docs/index.rst b/docs/index.rst index f0f0a1f2..b9a822d8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,20 +13,38 @@ Built on top of Dask to efficiently scale and parallelize operations across mult the `HiPSCat `_ data format for surveys in a partitioned HEALPix (Hierarchical Equal Area isoLatitude Pixelization) structure. +.. figure:: _static/gaia.png + :class: no-scaled-link + :scale: 80 % + :align: center + :alt: A possible HEALPix distribution for Gaia DR3 + + A possible HEALPix distribution for Gaia DR3. + In this website you will find: -- :doc:`Getting Started ` guides on how to install and run an example workflow -- :doc:`Tutorials `, and :doc:`Notebooks ` with more advanced usage examples +- Getting Started guides on how to :doc:`install ` and run an :doc:`example workflow ` +- :doc:`Tutorials ` with more advanced usage examples - The detailed :doc:`API Reference ` documentation -Learn more about contributing to this repository in our :doc:`Contribution Guide `. +Learn more about contributing to this repository in our :doc:`Contribution Guide `. .. toctree:: :hidden: Home page - Getting Started + Installation + Getting Started Tutorials - Notebooks + +.. toctree:: + :hidden: + :caption: Developer + API Reference + Contribution Guide + +.. toctree:: + :hidden: + Contact us diff --git a/docs/gettingstarted/installation.rst b/docs/installation.rst similarity index 100% rename from docs/gettingstarted/installation.rst rename to docs/installation.rst diff --git a/docs/notebooks.rst b/docs/notebooks.rst deleted file mode 100644 index 00199906..00000000 --- a/docs/notebooks.rst +++ /dev/null @@ -1,9 +0,0 @@ -Notebooks -======================================================================================== - -.. toctree:: - :maxdepth: 1 - - Cross-match ZTF BTS and NGC - Import and cross-match DES and Gaia - Import catalogs \ No newline at end of file diff --git a/docs/notebooks/README.md b/docs/notebooks/README.md deleted file mode 100644 index 4eb938ce..00000000 --- a/docs/notebooks/README.md +++ /dev/null @@ -1 +0,0 @@ -Put your Jupyter notebooks here :) \ No newline at end of file diff --git a/docs/tutorials.rst b/docs/tutorials.rst index e065afd3..354ba1dc 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -4,9 +4,21 @@ Tutorials These pages contain a set of tutorial notebooks for working through core and more advanced LSDB functionality. +Core functionality +------------------ .. toctree:: + :maxdepth: 1 Loading data into LSDB Working with large catalogs Margins - Exporting results \ No newline at end of file + Exporting results + +Other tutorials +--------------- +.. toctree:: + :maxdepth: 1 + + Import catalogs + Cross-match ZTF BTS and NGC + Import and cross-match DES and Gaia diff --git a/docs/notebooks/des-gaia.ipynb b/docs/tutorials/des-gaia.ipynb similarity index 100% rename from docs/notebooks/des-gaia.ipynb rename to docs/tutorials/des-gaia.ipynb diff --git a/docs/notebooks/import_catalogs.ipynb b/docs/tutorials/import_catalogs.ipynb similarity index 100% rename from docs/notebooks/import_catalogs.ipynb rename to docs/tutorials/import_catalogs.ipynb diff --git a/docs/gettingstarted/quickstart.ipynb b/docs/tutorials/quickstart.ipynb similarity index 100% rename from docs/gettingstarted/quickstart.ipynb rename to docs/tutorials/quickstart.ipynb diff --git a/docs/notebooks/ztf_bts-ngc.ipynb b/docs/tutorials/ztf_bts-ngc.ipynb similarity index 100% rename from docs/notebooks/ztf_bts-ngc.ipynb rename to docs/tutorials/ztf_bts-ngc.ipynb