Merge branch 'sphinx-doc' into 'master'

sphinx documentation skeleton

See merge request cds/advligorts!128

.gitignore

@@ -34,8 +34,12 @@ src/daqd/autom4te.cache
 # srctrl
 *.srctrl*
 
-#kernel module build files
+# kernel module build files
 modules.order
 
-#python compile files
-*__pycache__*
\ No newline at end of file
+# python compile files
+*__pycache__*
+
+# sphinx doc files
+*_build
+*_static

.gitlab-ci.yml

+# https://docs.gitlab.com/ee/ci/yaml/#stages
+# https://docs.gitlab.com/ee/ci/yaml/#pages
+# https://wiki.ligo.org/DASWG/GitLigoOrg
+# https://wiki.ligo.org/viewauth/DASWG/GitLigoOrg#Accessing_GitLab_Pages
+# https://git.ligo.org/lscsoft/example-ci-project/wikis/automatically-produce-documentation
+
+pages:
+  stage: deploy
+  only:
+    - master
+  image: igwn/base:buster
+  script:
+    - rm -rf public
+    - apt-get update
+    - apt-get install -y -qq python3-sphinx latexmk texlive texlive-latex-extra
+    - make html latexpdf
+    - mv docs/_build/html public
+    - mv docs/_build/advligorts.pdf public
+  artifacts:
+    paths:
+    - public

doc2/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.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
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc2/conf.py

+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# 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 sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'advLigoRTS'
+copyright = '2020, Rolf Bork'
+author = 'Rolf Bork, Jonathan Hanks, Erik von Reis, Jameson Rollins'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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'
+
+# 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 = ['_static']

doc2/daq.rst

+Configuring the data acquisition daemons
+========================================
+
+

doc2/diag.rst

+Diagnostic tools for the RTS
+============================

doc2/index.rst

+.. advLigoRTS documentation master file, created by
+   sphinx-quickstart on Wed Jul  8 15:45:15 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to advLigoRTS's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   install
+   rcg
+   daq
+   diag
+   
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc2/install.rst

+Installing the advLigoRTS software
+==================================
+
+
+Install Debian 10, add the cdssoft archive source, install::
+
+   $ apt install advligorts-cymac
+
+
+
+
+Setting up an advLigoRTS system
+-------------------------------

doc2/rcg.rst

+Using the Real-time Code Generator (RCG)
+========================================
+