Deploy documentation to gitlab pages

.gitlab-ci.yml

@@ -256,15 +256,20 @@ pages:
     image: python:3.8-slim
     dependencies:
         - unit test coverage
+    before_script:
+      - pip install -r docs/requirements.txt
+      - apt update
+      - apt install make
     script:
         - mkdir public
-        - mv htmlcov/* public/
+        - mv htmlcov public/htmlcov
+        - cd docs && make html && mv _build/html/* ../public/
     artifacts:
         paths:
         - public
         expire_in: 2 weeks
     rules:
-        - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
 
 # Development 
 deploy:

README.md

-# NRAO Archive and Pipeline Processing Interface
+# NRAO Workspaces
 
-Detailed documentation is available [on our Confluence page](https://open-confluence.nrao.edu/pages/viewpage.action?pageId=2491749).
+Workspaces provides a bulk processing facility for the production of science-ready data products. The key ideas of this facility are:
 
-## Overview
+- Processing is quality-assured
+- Processing is estimable, visible and cancellable
+- Processing utilizes large clusters for high throughput, such the local cluster or the public Open Science Grid
+- Processing may be set up prior to the availability of input products, and will kick off when they arrive
+- Processing options are edited by users and the provenance is tracked
 
-The NRAO archive system allows people to download raw data and advanced SRDP
-radio astronomical observation data products made using NRAO-affiliated instruments: 
-[The Very Large Array (VLA)](https://science.nrao.edu/facilities/vla), 
-[the Very Long Baseline Array (VLBA)](https://science.nrao.edu/facilities/vlba),
-[the Atacama Large Millimeter Array (ALMA)](http://www.almaobservatory.org/en/home/) 
-as well as the [the Green Bank Telescope (GBT)](http://greenbankobservatory.org/).
+Detailed documentation is available at our [Sphinx documentation site](https://ssa.gitlab-pages.nrao.edu/workspaces/).
 
-## Components
-
-This system has several subsystems which have their own subsystems. The two primary systems are:
-
-* The **archive** which stores data products
-* The **workspace** system which allows users to retrieve data products and transform them into other products
-
-The pieces are broken down into applications (both web-based and command-line), RESTful services and shared libraries.
-
-More details can be had by looking at our Confluence documentation.
-
-## Development Guide
-[Development](development.md)
+Coverage reports are also available at our [htmlcov site](https://ssa.gitlab-pages.nrao.edu/workspaces/htmlcov).
\ No newline at end of file

docs/requirements.txt

@@ -16,7 +16,7 @@ pandas
 pendulum
 pid
 pika
-psycopg2
+psycopg2-binary
 pycapo
 pyopenssl
 pyramid

docs/source/api/capability/modules.rst

@@ -5,4 +5,3 @@ capability
    :maxdepth: 4
 
    capability
-   test

docs/source/api/capability/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.conftest module
---------------------
-
-.. automodule:: test.conftest
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_capability\_request\_views module
---------------------------------------------
-
-.. automodule:: test.test_capability_request_views
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_capability\_server module
-------------------------------------
-
-.. automodule:: test.test_capability_server
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_capability\_views module
------------------------------------
-
-.. automodule:: test.test_capability_views
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/casa_envoy/modules.rst

@@ -5,4 +5,3 @@ casa_envoy
    :maxdepth: 4
 
    casa_envoy
-   test

docs/source/api/casa_envoy/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.test\_auditor module
--------------------------
-
-.. automodule:: test.test_auditor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_casa\_envoy module
------------------------------
-
-.. automodule:: test.test_casa_envoy
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/delivery/modules.rst

@@ -5,4 +5,3 @@ delivery
    :maxdepth: 4
 
    delivery
-   tests

docs/source/api/delivery/tests.rst

-tests package
-=============
-
-Submodules
-----------
-
-tests.test\_api module
-----------------------
-
-.. automodule:: tests.test_api
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-tests.test\_cli module
-----------------------
-
-.. automodule:: tests.test_cli
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-tests.test\_products module
----------------------------
-
-.. automodule:: tests.test_products
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: tests
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/messaging/modules.rst

@@ -5,4 +5,3 @@ messaging
    :maxdepth: 4
 
    messaging
-   test

docs/source/api/messaging/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.conftest module
---------------------
-
-.. automodule:: test.conftest
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_messenger module
----------------------------
-
-.. automodule:: test.test_messenger
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_router module
-------------------------
-
-.. automodule:: test.test_router
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/notification/modules.rst

@@ -5,4 +5,3 @@ notification
    :maxdepth: 4
 
    notification
-   test

docs/source/api/notification/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.conftest module
---------------------
-
-.. automodule:: test.conftest
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_notification\_server module
---------------------------------------
-
-.. automodule:: test.test_notification_server
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_notify\_views module
--------------------------------
-
-.. automodule:: test.test_notify_views
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/null/modules.rst

@@ -5,4 +5,3 @@ null
    :maxdepth: 4
 
    null
-   test

docs/source/api/null/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.test\_null module
-----------------------
-
-.. automodule:: test.test_null
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/vela/modules.rst

@@ -4,5 +4,4 @@ vela
 .. toctree::
    :maxdepth: 4
 
-   test
    vela

docs/source/api/vela/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.test\_forger module
-------------------------
-
-.. automodule:: test.test_forger
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-test.test\_vela module
-----------------------
-
-.. automodule:: test.test_vela
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/api/wf_monitor/modules.rst

@@ -4,5 +4,4 @@ wf_monitor
 .. toctree::
    :maxdepth: 4
 
-   test
    wf_monitor

docs/source/api/wf_monitor/test.rst

-test package
-============
-
-Submodules
-----------
-
-test.test\_wf\_monitor module
------------------------------
-
-.. automodule:: test.test_wf_monitor
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: test
-   :members:
-   :undoc-members:
-   :show-inheritance: