.. include:: ../../README.rst How the documentation is structured ----------------------------------- .. rst-class:: columns :ref:`tutorials` ~~~~~~~~~~~~~~~~ Tutorials for installation and usage. New users start here. .. rst-class:: columns :ref:`how-to` ~~~~~~~~~~~~~ Practical step-by-step guides for the more experienced user. .. rst-class:: columns :ref:`explanations` ~~~~~~~~~~~~~~~~~~~ Explanation of how the library works and why it works that way. .. rst-class:: columns :ref:`reference` ~~~~~~~~~~~~~~~~ Technically detailed API documenation. .. rst-class:: endcolumns About the documentation ~~~~~~~~~~~~~~~~~~~~~~~ `Why is the documentation structured this way? `_ .. toctree:: :caption: Tutorials :name: tutorials :maxdepth: 1 tutorials/install tutorials/search-and-lookup tutorials/get-data tutorials/get-metadata tutorials/export .. toctree:: :caption: How-to Guides :name: how-to :maxdepth: 1 how-to/download-data-samples how-to/file-backed-catalog how-to/store-data-from-run-engine how-to/store-analysis-results how-to/mongo-backed-catalog .. toctree:: :caption: Explanations :name: explanations :maxdepth: 1 explanations/v2-transition explanations/local-and-remote-use-cases explanations/relationship-to-intake .. rst-class:: no-margin-after-ul .. toctree:: :caption: Reference :name: reference :maxdepth: 1 reference/v2 reference/v1 reference/configuration reference/changelog * :ref:`genindex` .. toctree:: :hidden: :caption: Bluesky Project Homepage GitHub .. toctree:: :hidden: :caption: Getting Help Gitter