From 3321b58a6349d432b8f41ee43db4e5ffb5488d39 Mon Sep 17 00:00:00 2001 From: Wilson Beebe Date: Thu, 28 Mar 2024 15:54:03 -0700 Subject: [PATCH] Reorganize Documentation Homepage (#417) * Reorganize docs home page * Minor edits * Fix formatting * Yet another typo --- docs/index.rst | 50 ++++++++------------------------------------------ 1 file changed, 8 insertions(+), 42 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 6ed962b9..4f6721b5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,59 +11,25 @@ TAPE offers a complete ecosystem for loading, filtering, and analyzing timeseries data. TAPE is built to enable users to run provided and user-defined analysis functions at scale in a parallelized and/or distributed manner. -Over the survey lifetime of the [LSST](https://www.lsst.org/about), on order -~billionsof objects will have multiband lightcurves available, and TAPE has +Over the survey lifetime of the `LSST `_, on order +of ~billions of objects will have multiband lightcurves available, and TAPE has been built as a framework with the goal of making analysis of LSST-scale data accessible. TAPE is built on top of `Dask `_, and leverages its "lazy evaluation" to only load data and run computations when needed. -Start with the Getting Started section to learn the basics of installation and +How to Use This Guide +============================================== + +Begin with the `Getting Started `_ guide to learn the basics of installation and walk through a simple example of using TAPE. -The Tutorials section showcases the fundamental features of TAPE. +The `Tutorials `_ section showcases the fundamental features of TAPE. API-level information about TAPE is viewable in the -API Reference section. - - - -Dev Guide - Getting Started ---------------------------- - -Before installing any dependencies or writing code, it's a great idea to create a -virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual -environments. If you have conda installed locally, you can run the following to -create and activate a new environment. - -.. code-block:: console - - >> conda create env -n python=3.11 - >> conda activate - - -Once you have created a new environment, you can install this project for local -development using the following commands: - -.. code-block:: console - - >> pip install -e .'[dev]' - >> pre-commit install - >> conda install pandoc - - -Notes: +`API Reference `_ section. -1) The single quotes around ``'[dev]'`` may not be required for your operating system. -2) ``pre-commit install`` will initialize pre-commit for this local repository, so - that a set of tests will be run prior to completing a local commit. For more - information, see the Python Project Template documentation on - `pre-commit `_. -3) Installing ``pandoc`` allows you to verify that automatic rendering of Jupyter notebooks - into documentation for ReadTheDocs works as expected. For more information, see - the Python Project Template documentation on - `Sphinx and Python Notebooks `_. .. toctree::