general documentation

[prjemian]

time to create general documentation (out of source code) with examples and figures and stuff

here's a checklist to clear ... created from items in the RTD sidebar

• Demo
• Callbacks
• Demonstrate nscan and TuneAxis
• Devices
• Examples
• File Writers
• Plans
• bluesky_snapshot
• sscan record
• Suspenders
• swait record
• Utilities
• command-line applications

[prjemian]

Could also reorganize the order of appearance

[prjemian]

useful: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html

[prjemian]

Examples could improve with a plot but is sufficient for now.

[prjemian]

documentation of Utilities is sufficient

[prjemian]

documentation of Suspenders is sufficient

[prjemian]

Demonstrate nscan and TuneAxis will look much better as a notebook

[prjemian]

bluesky_snapshot needs its docs refreshed. It might benefit by moving into its own repo. Leave it here for now.

[prjemian]

SPEC file writer has documentation, could point to the new example.