From e2ed1682ea810ba7f0c612bc7e3382383d5ff8ad Mon Sep 17 00:00:00 2001 From: Doug Branton Date: Thu, 23 May 2024 11:41:23 -0700 Subject: [PATCH] update intro --- docs/index.rst | 45 +++++++++++++-------------------------------- 1 file changed, 13 insertions(+), 32 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 640eca4..d726a6c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,43 +13,24 @@ of nested associated datasets. This package wraps the majority of the Nested-Pandas API with Dask, which enables easy parallelization and capacity for work at scale. +How to Use This Guide +===================== -Dev Guide - Getting Started ---------------------------- +Begin with the :doc:`Getting Started ` +guide to learn the basics of installation and walkthrough a simple example of +using nested-dask. -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. +The :doc:`Tutorials ` +section showcases the fundamental features of nested-pandas. -.. code-block:: console +The :doc:`Best Practices ` guide provides a few +suggestions to avoid common pitfalls with Nested-Dask (and Dask in general). - >> conda create env -n python=3.10 - >> 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: - -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 `_. +API-level information about nested-pandas is viewable in the +:doc:`API Reference ` +section. +Learn more about contributing to this repository in our :doc:`Contribution Guide `. .. toctree:: :hidden: