Skip to content

Commit

Permalink
DOC re-arrange same content into 2x2 table
Browse files Browse the repository at this point in the history
  • Loading branch information
@prjemian
prjemian committed Apr 3, 2024
1 parent 0a0e630 commit ff95163
Showing 1 changed file with 109 additions and 65 deletions.
174 changes: 109 additions & 65 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky>`__
.. for documentation authors:
Documentation may be created in restructured text (.rst), markdown (.md)
of Jupyter notebooks (.ipynb). Add new documents to the appropriate folder
Expand All @@ -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 <howto/bluesky_cheat_sheet.md>`_:
First Steps to use Bluesky after installation.
- `Plot x, y data from a databroker run <https://bcda-aps.github.io/bluesky_training/howto/_plot_x_y_databroker.html>`_
- `Working with data after the measurement <https://bcda-aps.github.io/bluesky_training/howto/_after_measurement.html>`_
- :ref:`instrument`
- `Installation Guide <https://bcda-aps.github.io/bluesky_training/instrument/_install_new_instrument.html>`_:
Install the components of the Bluesky framework.
- `Template <https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky/instrument>`_
for a bluesky ``instrument``
- `Instrument Package Guide <instrument/guide.md>`__:
Building the ``instrument`` package.
- `About the instrument package <file:///home/prjemian/Documents/projects/BCDA-APS/bluesky_training/docs/build/html/instrument/describe_instrument.html>`_
- :ref:`examples`
- `XAFS scan <https://bcda-aps.github.io/bluesky_training/example/_xafs_scan.html>`_ : Example multi-segment XAFS scan.
- :ref:`Tutorials and Lessons <tutorials>`
- `Hello, World <https://bcda-aps.github.io/bluesky_training/tutor/hello_world.html>`_
- `Connect Bluesky with EPICS <https://bcda-aps.github.io/bluesky_training/tutor/connect_epics.html>`_
- :ref:`reference`
- `bluesky training wiki <https://github.com/BCDA-APS/bluesky_training/wiki>`_:
Includes list of APS instruments
- `General Bluesky Documentation (for APS) <https://wiki-ext.aps.anl.gov/blc/index.php?title=Controls_Software_Documentation#Bluesky>`_
<table style="border: 5px">
<caption>
Documentation is categorized in four major sections.
<br />
In addition to these highlights, additional content
is available in each section of the documentation.
</caption>
<tr>
<td style="width:40%; vertical-align:text-top; padding-bottom: 20px">
<a href="howto/index.html"><b>How-to Guides</b></a>
<br />
Practical guides for accomplishing specific tasks.
<ul>
<li>
<a href="howto/bluesky_cheat_sheet.html">Bluesky Cheat Sheet</a>:
First Steps to use Bluesky after installation.
</li>
<li>
<a href="howto/_plot_x_y_databroker.html">
Plot x, y data from a databroker run
</a>
</li>
<li>
<a href="howto/_after_measurement.html">
Working with data after the measurement
</a>
</li>
</ul>
<a href="example/index.html"><b>Examples</b></a>
Demonstrations of specific tasks.
<ul>
<li>
<a href="example/_xafs_scan.html">XAFS scan</a>:
Example multi-segment XAFS scan.
</li>
</ul>
</td>
<td style="width:40%; vertical-align:text-top; padding-bottom: 10px">
<a href="instrument/index.html"><b>Instrument</b></a>
<br />
Details to configure and develop your <em>instrument</em> package.
<br />
<ul>
<li>
<a href="instrument/_install_new_instrument.html">Installation Guide</a>:
Install the components of the Bluesky framework.
</li>
<li>
<a href="https://github.com/BCDA-APS/bluesky_training/tree/main/bluesky/instrument">
Template
</a> for a bluesky <em>instrument</em> package.
</li>
<li>
<a href="instrument/guide.html">Instrument Package Guide</a>:
Building the <em>instrument</em> package.
</li>
<li>
<a href="instrument/describe_instrument.html">About the instrument package</a>
</li>
</ul>
</td>
</tr>
<tr>
<td style="width:40%; vertical-align:text-top; padding-bottom: 20px">
<a href="tutor/index.html"><b>Tutorials and Lessons</b></a>
<br />
Step-by-step guides to help you get started and learn through doing.
<ul>
<li>
<a href="tutor/hello_world.html">Hello, World</a>
</li>
<li>
<a href="tutor/connect_epics.html">Connect Bluesky with EPICS</a>
</li>
</ul>
</td>
<td style="width:40%; vertical-align:text-top; padding-bottom: 20px">
<a href="reference/index.html"><b>Reference</b></a>
<br />
Reference material to learn more about Bluesky.
<ul>
<li>
<a href="https://github.com/BCDA-APS/bluesky_training/wiki">
bluesky training wiki
</a>:
Includes list of APS instruments.
</li>
<li>
<a href="https://wiki-ext.aps.anl.gov/blc/index.php?title=Controls_Software_Documentation#Bluesky">
General Bluesky Documentation (for APS)
</a>
</li>
<li>
<a href="reference/_zz_other_resources.html">Other resources</a>
</li>
</ul>
</td>
</tr>
</table>

.. toctree::
:maxdepth: 1
Expand All @@ -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 <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 <changes>`
:index: :ref:`genindex`

.. * :ref:`modindex`
.. * :ref:`search`

0 comments on commit ff95163

Please sign in to comment.