diff --git a/docs/source/index.rst b/docs/source/index.rst index d32c0c75..b323f128 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,14 +1,10 @@ APS Bluesky Training ==================== -The APS Bluesky Training repository [#]_ demonstrates use of the Bluesky -framework at a typical APS beamline. Its ``bluesky/`` directory [#]_ also +This APS Bluesky Training repository demonstrates use of the Bluesky +framework at a typical APS beamline. Its ``bluesky/`` directory also serves as a template for new beamline installations. -.. [#] repository: https://github.com/BCDA-APS/bluesky_training -.. [#] ``bluesky/`` directory: new beamline - `template `__ - .. for documentation authors: Documentation may be created in restructured text (.rst), markdown (.md) of Jupyter notebooks (.ipynb). Add new documents to the appropriate folder @@ -17,31 +13,107 @@ serves as a template for new beamline installations. files which do not start with a "_" are added explicitly to the toctree in the `index.rst` file of that folder. -In addition to these highlights, additional content is available in each section -of the documentation. +.. raw:: html -- :ref:`howto` - - `Bluesky Cheat Sheet `_: - First Steps to use Bluesky after installation. - - `Plot x, y data from a databroker run `_ - - `Working with data after the measurement `_ -- :ref:`instrument` - - `Installation Guide `_: - Install the components of the Bluesky framework. - - `Template `_ - for a bluesky ``instrument`` - - `Instrument Package Guide `__: - Building the ``instrument`` package. - - `About the instrument package `_ -- :ref:`examples` - - `XAFS scan `_ : Example multi-segment XAFS scan. -- :ref:`Tutorials and Lessons ` - - `Hello, World `_ - - `Connect Bluesky with EPICS `_ -- :ref:`reference` - - `bluesky training wiki `_: - Includes list of APS instruments - - `General Bluesky Documentation (for APS) `_ + + + + + + + + + + +
+ Documentation is categorized in four major sections. +
+ In addition to these highlights, additional content + is available in each section of the documentation. +
+ How-to Guides +
+ Practical guides for accomplishing specific tasks. + + Examples + Demonstrations of specific tasks. +
    +
  • + XAFS scan: + Example multi-segment XAFS scan. +
    • +
+ 		+ Instrument +
+ Details to configure and develop your instrument package. +
+ +
+ Tutorials and Lessons +
+ Step-by-step guides to help you get started and learn through doing. + + 		+ Reference +
+ Reference material to learn more about Bluesky. + +
.. toctree:: :maxdepth: 1 @@ -54,42 +126,14 @@ of the documentation. reference/index changes -Other resources -================== - -* apstools - * home: https://bcda-aps.github.io/apstools/latest/ - * source: https://github.com/BCDA-APS/apstools - * PyPI: https://pypi.org/project/apstools/ - * conda: https://anaconda.org/conda-forge/apstools -* Bluesky framework - * home: https://blueskyproject.io - * source: https://github.com/bluesky - * conda: all packages available on conda-forge channel -* MongoDB - * home: https://www.mongodb.com/ -* PyDM - * home: https://slaclab.github.io/pydm/ - * source: https://github.com/slaclab/pydm - * PyPI: https://pypi.org/project/pydm/ - * conda: https://anaconda.org/conda-forge/pydm -* PyEPICS - * home: https://pyepics.github.io/pyepics/ - * source: https://github.com/pyepics/pyepics - * PyPI: https://pypi.org/project/pyepics/ - * conda: https://anaconda.org/conda-forge/pyepics -* APS Data Management - * home: https://confluence.aps.anl.gov/display/DMGT/ - -Revision History -================== - -:ref:`History of code changes ` - -Index -================== +About +----- -* :ref:`genindex` +:home: https://prjemian.github.io/pyQParamWidget/ +:source: https://github.com/prjemian/pyQParamWidget +:published: |today| +:revisions: :ref:`History of code changes ` +:index: :ref:`genindex` .. * :ref:`modindex` .. * :ref:`search`