Implement Readthedocs

rtd/.readthedocs.yaml

@@ -0,0 +1,22 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: rtd/docs/source/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: rtd/docs/requirements.txt

rtd/README.rst

@@ -0,0 +1,46 @@
+OVIS-HPC Maestro Documentation
+########################
+
+This repository hosts all Maestro related documentation such as how-to tutorials, getting started with Maestro, docker-hub links, API's and much more. Documentation webpage can be found in the `Maestro readthedocs webpage <https://ovis-hpc.readthedocs.io/projects/maestro/en/latest/>`_
+
+Contributing to ReadTheDocs
+############################
+Instructions and documentation on how to use ReadTheDocs can be found here:
+`readthedocs Help Guide <https://sublime-and-sphinx-guide.readthedocs.io/en/latest/images.html>`_
+
+
+* Clone the repository:
+
+.. code-block:: RST
+
+  > git clone [email protected]:<current-repo>/ovis-docs.git
+
+* Add any existing file name(s) you will be editing to paper.lock
+
+.. code-block:: RST
+
+  > vi paper.lock
+  <add Name | Date | File(s)>
+  <username> | mm/dd | <filename>
+
+* Make necessary changes, update paper.lock file and push to repo.
+
+.. code-block:: RST
+
+  > vi paper.lock
+  <add Name | Date | File(s)>
+  ## remove line
+  > git add <files>
+  > git commit -m "add message"
+  > git push
+
+Adding A New File
+******************
+For any new RST files created, please include them in rtd/docs/src/index.rst under their corresponding sections. All RST files not included in index.rst will not populate on the offical webpage (e.g. readthedocs).
+
+Paper Lock
+************
+This is for claiming any sections you are working on so there is no overlap.
+Please USE paper.lock to indicate if you are editing an existing RST file.
+
+

rtd/docs/Makefile

@@ -0,0 +1,20 @@
+# 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     = source
+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)

rtd/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

rtd/docs/requirements.txt

@@ -0,0 +1,2 @@
+# compatable with the newest version of Sphinx (v7.2.1)
+sphinx_rtd_theme==1.3.0rc1

rtd/docs/source/conf.py

@@ -0,0 +1,50 @@
+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'OVIS-HPC'
+copyright = '2024, Sandia National Laboratories and Open Grid Computing, Inc.'
+author = 'SNL/OGC'
+
+release = '0.1'
+version = '0.1.0'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+]
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+
+    # Link to the "apis" of the "hpc-ovis" project and subprojects
+    "ovis-hpc": ("https://ovis-hpc.readthedocs.io/en/latest/", None),
+    "sos": ("https://ovis-hpc.readthedocs.io/projects/sos/en/latest/", None),
+    "maestro": ("https://ovis-hpc.readthedocs.io/projects/maestro/en/latest/", None),
+    "baler": ("https://ovis-hpc.readthedocs.io/projects/baler/en/latest/", None),
+    "ldms": ("https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/", None),
+
+}
+intersphinx_disabled_domains = ['std']
+intersphinx_disabled_reftypes = ["*"]
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['static']
+html_logo = "https://github.com/ovis-hpc/readthedocs/blob/main/docs/source/images/ovis-logo.png?raw=true"
+html_theme_options = {
+    'logo_only': True,
+    'display_version': False,
+}
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

rtd/docs/source/deployment/index.rst

@@ -0,0 +1,9 @@
+Maestro Deployment
+===============
+This section covers how to deploy and test Maestro
+
+.. toctree::
+   :maxdepth: 2
+
+   test
+

rtd/docs/source/deployment/test.rst

@@ -0,0 +1,4 @@
+Github
+======
+
+Documentation for this is currently under development.

rtd/docs/source/index.rst

@@ -0,0 +1,67 @@
+.. Copyright 2023 Sandia National Laboratories, LLC
+   (c.f. AUTHORS, NOTICE.LLNS, COPYING)
+
+   SPDX-License-Identifier: (LGPL-3.0)
+
+.. Flux documentation master file, created by
+   sphinx-quickstart on Fri Jan 10 15:11:07 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome To OVIS-HPC Documentation!
+====================================
+.. image:: https://github.com/ovis-hpc/readthedocs/blob/main/docs/source/images/ovis-logo.png?raw=true
+   :width: 225
+   :height: 250
+   :align: center
+
+**OVIS** is a modular system for HPC data collection, transport, storage, analysis, visualization, and log message exploration. The Lightweight Distributed Metric Service (**LDMS**) is a scalable low-overhead, low-latency framework for collection, movement, and storage of metric/event data on distributed computer systems.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: OVIS and Group Activity
+
+   About Ovis <https://ovis-hpc.readthedocs.io/en/latest/aboutovis.html>
+   LDMS Users Group Conference (LDMSCON) <https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/ldmscon.html>
+   LDSM Users Group <https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/ug.html>
+   OVIS Publications <https://ovis-hpc.readthedocs.io/en/latest/publications.html>
+
+.. toctree::
+   :maxdepth: 4
+   :caption: OVIS Components
+
+   LDMS <https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/ldms-index.html>
+   SOS <https://ovis-hpc.readthedocs.io/projects/sos/en/latest/sos-index.html>
+   maestro-index
+   Baler <https://ovis-hpc.readthedocs.io/projects/baler/en/latest/baler-index.html>
+   ASF <https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/asf/index.html>
+
+.. toctree::
+   :maxdepth: 6
+   :caption: Deployment
+
+   LDMS <https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/deployment/index.html>
+   SOS <https://ovis-hpc.readthedocs.io/projects/sos/en/latest/deployment/index.html>
+   deployment/index
+   Baler <https://ovis-hpc.readthedocs.io/projects/baler/en/latest/deployment/index.html>
+   ASF <https://ovis-hpc.readthedocs.io/projects/ldms/en/latest/asf/deployment/index.html>
+
+
+Other Projects
+====================================
+
+`ldms <https://github.com/ovis-hpc/ovis>`_
+`ovis-publications <https://github.com/ovis-hpc/ovis-publications>`_
+`maestro <https://github.com/ovis-hpc/maestro>`_
+`sos <https://github.com/ovis-hpc/sos>`_
+`baler <https://github.com/ovis-hpc/baler>`_
+
+
+
+
+
+
+
+
+
+

rtd/docs/source/maestro-index.rst

@@ -0,0 +1,8 @@
+Maestro
+====================================
+.. toctree::
+   :maxdepth: 2
+   :caption: Introduction To Maestro
+
+   maestro-quickstart
+