[docs] REST API documentation

docs/PG/AboutThisGuide.rst → docs/PG/AboutPGGuide.rst

@@ -1,4 +1,4 @@
-.. _AboutThisGuide:
+.. _AboutPGGuide:
 
 About Programmer's Guide
 #########################
@@ -106,7 +106,7 @@ The following conventions are used throughout this document:
    * - ALL CAPS
      - All capital letters denote environment variables, operator names, directives, defined constants, and macros in C programs.                         
    * - ()
-     - Parentheses that follow function names surround function arguments or are empty if the function has no arguments; parentheses that follow commands surround man page section numbers.                                                                                                                 |
+     - Parentheses that follow function names surround function arguments or are empty if the function has no arguments; parentheses that follow commands surround man page section numbers.
 
 
 Reader Comments

docs/UAG/AboutThisGuide.rst → docs/UAG/AboutUAGGuide.rst

@@ -1,4 +1,4 @@
-.. _AboutThisGuide:
+.. _AboutUAGGuide:
 
 About User's and Administrator's Guide
 #######################################
@@ -110,7 +110,7 @@ The following conventions are used throughout this document:
    * - ALL CAPS
      - All capital letters denote environment variables, operator names, directives, defined constants, and macros in C programs.                         
    * - ()
-     - Parentheses that follow function names surround function arguments or are empty if the function has no arguments; parentheses that follow commands surround man page section numbers.                                                                                                                 |
+     - Parentheses that follow function names surround function arguments or are empty if the function has no arguments; parentheses that follow commands surround man page section numbers.
 
 
 Reader Comments

docs/conf.py

@@ -16,6 +16,8 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import os
+import pkg_resources
 
 # -- Project information -----------------------------------------------------
 
@@ -38,7 +40,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [ 'sphinx.ext.autosectionlabel'
+extensions = [ 'sphinx.ext.autosectionlabel','sphinxcontrib.redoc', 'sphinxcontrib.openapi'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -76,6 +78,26 @@
 #
 html_theme = 'sphinx_rtd_theme'
 
+redoc = [
+    {
+        'name': 'PMWEBAPI',
+        'page': 'api/index',
+        'spec': 'specs/openapi.yaml',
+        'opts': {
+            'lazy-rendering': True,
+
+        },
+    },
+]
+
+redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
+
+if not os.environ.get('READTHEDOCS') == 'True':
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+
 # 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.
@@ -170,4 +192,4 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ['search.html']

docs/index.rst

@@ -12,12 +12,18 @@ abstraction for all of the performance data in a system, and many tools for inte
 PCP is a feature-rich, mature, extensible, cross-platform toolkit supporting both live and retrospective analysis. The distributed PCP architecture 
 makes it especially useful for those seeking centralized monitoring of distributed processing.
 
+**Table of Contents**
+
+* :doc:`UAG/AboutUAGGuide`
+* :doc:`PG/AboutPGGuide`
+* `REST API - PMWEBAPI <api/>`__
+
 .. toctree::
    :caption: Guides
    :hidden:
 
-   UAG/AboutThisGuide
-   PG/AboutThisGuide
+   UAG/AboutUAGGuide
+   PG/AboutPGGuide
 
 
 .. toctree::
@@ -45,4 +51,3 @@ makes it especially useful for those seeking centralized monitoring of distribut
    PG/PMAPI
    PG/InstrumentingApplications
 
-