Maintenance will be performed on,,, and 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

Commit 3b7bc303 authored by Alexander Pace's avatar Alexander Pace

Adding Sphinx documentation

parent 7f5fd6da
Pipeline #42557 passed with stage
in 3 minutes and 44 seconds
# Minimal makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
SPHINXPROJ = ligo.lvalert
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# GWCelery documentation build configuration file, created by
# sphinx-quickstart on Tue Dec 5 14:59:24 2017.
# This file is execfile()d with the current directory set to its
# containing dir.
# Note that not all possible configuration values are present in this
# autogenerated file.
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
import os
import importlib
from subprocess import check_output
import sys
sys.path.insert(0, os.path.abspath('..'))
def get_setup_output(*args):
return check_output((sys.executable, '') + args, cwd='..').decode()
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
source_suffix = ['.rst', '.md']
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = get_setup_output('--name')
author = get_setup_output('--author')
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The short X.Y version.
version = get_setup_output('--version')
# The full version, including alpha/beta/rc tags.
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
autodoc_mock_imports = []
for mod in []:
except ImportError:
autodoc_default_flags = ['members', 'show-inheritance']
autosummary_generate = True
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'description': get_setup_output('--description'),
'github_button': False,
'logo_name': True
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
# This is required for the alabaster theme
# refs:
html_sidebars = {
'**': []
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = project + 'doc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
# Latex figure (float) alignment
# 'figure_align': 'htbp',
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, project + '.tex', project + ' Documentation',
author, 'manual'),
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, project.lower(), project + ' Documentation',
[author], 1)
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, project, project + ' Documentation',
author, project, 'One line description of project.',
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'python': ('', None),
'sleekxmpp': ('', None)
# -- Options for viewcode extension ---------------------------------------
# celery.contrib.sphinx does not show source links for tasks if this is set
# to the default value of True
viewcode_import = False
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.
Quick Start
Install with pip_::
pip install ligo-lvalert
Put your username and password in your netrc_ file in ``~/.netrc``::
echo 'machine login albert.einstein password gravity' >> ~/.netrc
chmod 0600 ~/.netrc
Subscribe to some nodes::
lvalert subscribe cbc_gstlal cbc_pycbc cbc_mbtaonline
Listen for LVAlert messages::
lvalert listen
.. automodule:: ligo.lvalert
Command Line Interface
.. argparse::
:module: ligo.lvalert.tool
:func: parser
.. _netrc:
.. _SleekXMPP:
.. _PyXMPP:
.. _pip:
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
set BUILDDIR=_build
set SPHINXPROJ=ligo.lvalert
if "%1" == "" goto help
if errorlevel 9009 (
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.If you don't have Sphinx installed, grab it from
exit /b 1
goto end
......@@ -17,12 +17,14 @@
# along with lvalert. If not, see <>.
import os
import os, sys
from setuptools import setup, find_packages
version = "1.5.4"
install_reqs = []
name = "ligo-lvalert",
version = version,
......@@ -37,7 +39,8 @@ setup(
# provides = ['ligo.lvalert'],
packages = find_packages(),
install_requires = ['sleekxmpp', 'dnspython', 'numpy', 'six'],
install_requires = install_reqs.extend(['sleekxmpp', 'dnspython', 'numpy', 'six']),
#install_requires = ['sleekxmpp', 'dnspython', 'numpy', 'six','recommonmark', 'sphinx', 'sphinx-argparse'],
scripts = [
......@@ -52,6 +55,7 @@ setup(
# Dependencies.
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment