Merge pull request #124 from alurban/update-docs

Introducing public documentation of hveto

.gitignore

@@ -11,7 +11,9 @@
 
 # documentation products
 /docs/_build/
-/docs/api/
+/docs/_generated/
+/docs/api/modules.rst
+/docs/api/hveto.*
 
 # test products
 /.cache/

.readthedocs.yml

@@ -0,0 +1,30 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build docs in additional formats
+formats: all
+
+# include submodules
+submodules:
+  include: all
+
+# Set the version of Python and requirements required to build your docs
+python:
+   version: 3.7
+   install:
+      - requirements: docs/requirements.txt
+      - requirements: requirements.txt
+      - method: setuptools
+        path: .
+      - method: pip
+        path: .
+        extra_requirements:
+           - docs

README.rst

@@ -1,24 +1,27 @@
-HVeto is a python implementation of the HierarchicalVeto algorithm. It is
-a package designed for for gravitational-wave detector characterisation and
+=================
+Hierarchical Veto
+=================
+
+Hveto is a python implementation of the HierarchicalVeto algorithm. It is
+a package designed for gravitational-wave detector characterisation and
 data quality.
 
-|PyPI version| |DOI| |License| |Supported Python versions|
+The Hveto algorithm is fully described in `Smith et al. 2011`_
+(Classical and Quantum Gravity).
+
+|PyPI version| |Conda version|
 
-|Build Status| |Coverage Status|
+|DOI| |License| |Supported Python versions|
 
-------
-Method
-------
+|Build Status| |Coverage Status| |Documentation Status|
 
-The HVeto algorithm is fully described in `Smith et al. 2011`_
-(Classical and Quantum Gravity). `Documentation`_ for running HVeto
-is also available, but requires LIGO.ORG credentials.
+https://hveto.readthedocs.io
 
 ------------
 Installation
 ------------
 
-HVeto is best installed with `conda`_:
+Hveto is best installed with `conda`_:
 
 .. code:: bash
 
@@ -47,10 +50,11 @@ proposing additions/changes.
 .. _conda: https://conda.io
 .. _pip: https://pip.pypa.io/en/stable/
 .. _Smith et al. 2011: //dx.doi.org/10.1088/0264-9381/28/23/235005
-.. _Documentation: https://ldas-jobs.ligo.caltech.edu/~duncan.macleod/hveto/latest/
 
 .. |PyPI version| image:: https://badge.fury.io/py/hveto.svg
    :target: http://badge.fury.io/py/hveto
+.. |Conda version| image:: https://img.shields.io/conda/vn/conda-forge/hveto.svg
+   :target: https://anaconda.org/conda-forge/hveto/
 .. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/2584615.svg
    :target: https://doi.org/10.5281/zenodo.2584615
 .. |License| image:: https://img.shields.io/pypi/l/hveto.svg
@@ -61,3 +65,5 @@ proposing additions/changes.
    :target: https://travis-ci.org/gwdetchar/hveto
 .. |Coverage Status| image:: https://codecov.io/gh/gwdetchar/hveto/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/gwdetchar/hveto
+.. |Documentation Status| image:: https://readthedocs.org/projects/hveto/badge/?version=stable
+   :target: https://hveto.readthedocs.io/en/stable/?badge=stable

bin/hveto-cache-events

@@ -17,7 +17,7 @@
 # You should have received a copy of the GNU General Public License
 # along with hveto.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Create a (temporary) cache of event triggers for analysis by `hveto` later
+"""Create a (temporary) cache of event triggers for analysis by `hveto`
 
 This method will apply the minimal SNR thresholds and any frequency cuts
 as given in the configuration files

bin/hveto-trace

@@ -16,8 +16,9 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with hveto.  If not, see <http://www.gnu.org/licenses/>.
-# """Check if a trigger was vetoed by a specified hveto run.
-# """
+
+"""Check if a trigger was vetoed by a specified hveto run
+"""
 
 import os
 import sys

docs/_static/css/custom.css

@@ -0,0 +1,216 @@
+/.text-primary {
+    color: #4ba6ff;
+}
+
+.bg-primary {
+    background-color: #4ba6ff;
+}
+
+.btn-primary {
+    background-color: #4ba6ff;
+    border-color: #4ba6ff;
+}
+
+a.text-primary:hover, a.text-primary:focus {
+    color: #0080fe;
+}
+
+a.bg-primary:hover, a.bg-primary:focus {
+    background-color: #0080fe;
+}
+
+.btn-primary:focus, .btn-primary.focus {
+    background-color: #0080fe;
+    border-color: #0080fe;
+}
+
+.btn-primary:hover {
+    background-color: #0080fe;
+    border-color: #0080fe;
+}
+
+.btn-primary:active, .btn-primary.active, .open > .dropdown-toggle.btn-primary {
+    background-color: #0080fe;
+    border-color: #0080fe
+}
+
+.navbar-default .navbar-nav > .active > a, .navbar-default .navbar-nav > .active > a:hover,
+.navbar-default .navbar-nav > .active > a:focus {
+    background-color: #0080fe
+}
+
+.navbar-default .navbar-nav > .open > a, .navbar-default .navbar-nav > .open > a:hover,
+.navbar-default .navbar-nav > .open > a:focus {
+    background-color: #0080fe;
+}
+
+.label-primary[href]:hover, .label-primary[href]:focus {
+    background-color: #0080fe
+}
+
+a.text-primary:hover, a.text-primary:focus {
+    color: #0080fe
+}
+
+a.bg-primary:hover, a.bg-primary:focus {
+    background-color: #0080fe
+}
+
+.btn-primary:focus, .btn-primary.focus {
+    background-color: #0080fe;
+    border-color: #0080fe
+}
+
+.btn-primary:hover {
+    background-color: #0080fe;
+    border-color: #0080fe
+}
+
+.btn-primary:active, .btn-primary.active, .open > .dropdown-toggle.btn-primary {
+    background-color: #0080fe;
+    border-color: #0080fe
+}
+
+.navbar-default .navbar-nav > .open > a, .navbar-default .navbar-nav > .open > a:hover,
+.navbar-default .navbar-nav > .open > a:focus {
+    background-color: #0080fe;
+}
+
+
+.label-primary[href]:hover, .label-primary[href]:focus {
+    background-color: #0080fe
+}
+
+.btn-primary.disabled:hover, .btn-primary[disabled]:hover, fieldset[disabled] .btn-primary:hover,
+.btn-primary.disabled:focus, .btn-primary[disabled]:focus, fieldset[disabled] .btn-primary:focus,
+.btn-primary.disabled.focus, .btn-primary[disabled].focus, fieldset[disabled] .btn-primary.focus {
+    background-color: #4ba6ff;
+    border-color: #4ba6ff;
+}
+
+.btn-primary .badge {
+    color: #4ba6ff;
+}
+
+.btn-link {
+    color: #4ba6ff;
+}
+
+.dropdown-menu > li > a:hover, .dropdown-menu > li > a:focus {
+    background-color: #4ba6ff;
+}
+
+.dropdown-menu > .active > a, .dropdown-menu > .active > a:hover, .dropdown-menu > .active > a:focus {
+    background-color: #4ba6ff;
+}
+
+.nav .open > a, .nav .open > a:hover, .nav .open > a:focus {
+    border-color: #4ba6ff;
+}
+
+.nav-pills > li.active > a, .nav-pills > li.active > a:hover, .nav-pills > li.active > a:focus {
+    background-color: #4ba6ff;
+}
+
+.navbar-default {
+    background-color: #4ba6ff;
+    border-color: #4ba6ff;
+}
+
+.navbar-default .navbar-nav > li > a:hover, .navbar-default .navbar-nav > li > a:focus {
+    background-color: #188dff;
+}
+
+.navbar-default .navbar-toggle {
+    border-color: #188dff
+}
+
+.navbar-default .navbar-toggle:hover, .navbar-default .navbar-toggle:focus {
+    background-color: #188dff
+}
+
+@media (max-width:767px) {
+    .navbar-default .navbar-nav .open .dropdown-menu > li > a:hover, .navbar-default .navbar-nav .open .dropdown-menu > li > a:focus {
+        background-color: #188dff
+    }
+
+    .navbar-default .navbar-nav .open .dropdown-menu > .active > a, .navbar-default .navbar-nav .open .dropdown-menu > .active > a:hover,
+    .navbar-default .navbar-nav .open .dropdown-menu > .active > a:focus {
+        background-color: #0080fe
+    }
+}
+
+.pagination > li > a:hover, .pagination > li > span:hover, .pagination > li > a:focus,
+.pagination > li > span:focus {
+    color: #188dff;
+}
+
+a:hover, a:focus {
+    color: #188dff;
+}
+
+.btn-link:hover, .btn-link:focus {
+    color: #188dff;
+}
+
+.navbar-default .navbar-nav > li > a:hover, .navbar-default .navbar-nav > li > a:focus {
+    background-color: #188dff;
+}
+
+.navbar-default .navbar-toggle {
+    border-color: #188dff;
+}
+
+.navbar-default .navbar-collapse, .navbar-default .navbar-form {
+    border-color: #d34615
+}
+
+.pagination > li > a, .pagination > li > span {
+    color: #4ba6ff;
+}
+
+.label-primary {
+    background-color: #4ba6ff;
+}
+
+.list-group-item.active > .badge, .nav-pills > .active > a > .badge {
+    color: #4ba6ff;
+}
+
+a.thumbnail:hover, a.thumbnail:focus, a.thumbnail.active {
+    border-color: #4ba6ff;
+}
+
+.progress-bar {
+    background-color: #4ba6ff;
+}
+
+.list-group-item.active, .list-group-item.active:hover, .list-group-item.active:focus {
+    background-color: #4ba6ff;
+    border-color: #4ba6ff;
+}
+
+.panel-primary {
+    border-color: #4ba6ff;
+}
+
+.panel-primary > .panel-heading {
+    background-color: #4ba6ff;
+    border-color: #4ba6ff;
+}
+
+.panel-primary > .panel-heading + .panel-collapse > .panel-body {
+    border-top-color: #4ba6ff;
+}
+
+.panel-primary > .panel-heading .badge {
+    color: #4ba6ff;
+}
+
+.panel-primary > .panel-footer + .panel-collapse > .panel-body {
+    border-bottom-color: #4ba6ff;
+}
+
+.navbar-default .badge {
+    color: #4ba6ff;
+}

docs/api/index.rst

@@ -0,0 +1,8 @@
+API
+---
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   *