Maintenance will be performed on git.ligo.org, chat.ligo.org, containers.ligo.org, and docs.ligo.org on Tuesday 26 May 2020 starting at approximately 10am CDT. It is expected to take around 30 minutes and will involve a short period of downtime, around 5 minutes, towards the end of the maintenance period. Please address any questions, comments, or concerns to uwm-help@cgca.uwm.edu.

Commit 502d1154 authored by Alexander Pace's avatar Alexander Pace

Update index.rst: setting up framework for users guide

parent 13a9e406
Pipeline #55535 passed with stages
in 4 minutes and 9 seconds
......@@ -2,8 +2,11 @@ ligo-lvalert Documentation
============================
ligo-lvalert is a client for the LIGO/Virgo LVAlert pubsub infrastructure that
is powered by SleekXMPP_. It is compatible with Python 3. For backwards compatibility,
legacy Python clients powered by PyXMPP_ (RIP) are included in the package.
is powered by SleekXMPP_.
The CLI and API are compatible with Python 3. For backwards compatibility,
legacy Python clients powered by PyXMPP_ are included in the package, but are
slated to be removed from a future release of ligo-lvalert.
Quick Start
-----------
......@@ -25,6 +28,12 @@ Listen for LVAlert messages::
lvalert listen
User Guide
----------
Please visit the `LVAlert User Guide`_ for a brief overview and starter for the LVAlert
client and service.
API
---
......@@ -41,3 +50,5 @@ Command Line Interface
.. _SleekXMPP: http://sleekxmpp.com
.. _PyXMPP: http://pyxmpp.jajcus.net/
.. _pip: http://pip.pypa.io
.. _Account Activation: https://www.lsc-group.phys.uwm.edu/cgi-bin/jabber-acct.cgi
.. _LVAlert User Guide: guide.html
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment