Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs] REST API documentation #1117

Merged
merged 5 commits into from Oct 21, 2020
Merged

[docs] REST API documentation #1117

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8d10bd0
REST API added
arzoo14 Oct 20, 2020
8f7ab64
Delete index.html - unnecessary file
arzoo14 Oct 20, 2020
c03cc2a
improvements
arzoo14 Oct 20, 2020
7e72873
Merge branch 'master' of https://github.com/performancecopilot/pcp in…
arzoo14 Oct 20, 2020
a9842bd
Merge branch 'books' of https://github.com/arzoo14/pcp into books
arzoo14 Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/PG/AboutThisGuide.rst → docs/PG/AboutPGGuide.rst
View file
Open in desktop
@@ -1,4 +1,4 @@
.. _AboutThisGuide:
.. _AboutPGGuide:

About Programmer's Guide
#########################
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/UAG/AboutThisGuide.rst → docs/UAG/AboutUAGGuide.rst
View file
Open in desktop
@@ -1,4 +1,4 @@
.. _AboutThisGuide:
.. _AboutUAGGuide:

About User's and Administrator's Guide
#######################################
Expand Down Expand Up @@ -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
Expand Down
28 changes: 27 additions & 1 deletion docs/conf.py
View file
Open in desktop
Expand Up @@ -16,6 +16,8 @@
# import sys
# sys.path.insert(0, os.path.abspath('.'))

import os
import pkg_resources

# -- Project information -----------------------------------------------------

Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -171,3 +193,7 @@

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

from docutils.parsers.rst import directives
from sphinx.directives.code import CodeBlock
directives.register_directive('code', CodeBlock)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this required for the ``` blocks in the openapi.yaml file?
If yes, is it possible to change the syntax highlighting language? Some code blocks look weird, for example https://demozxc.readthedocs.io/en/latest/api/#operation/get/series/instances (605 is colored differently than the rest of the ID).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! I forgot to remove these lines. These were just to check something.
Yes, I have changed the syntax highlighting language to bash

11 changes: 8 additions & 3 deletions docs/index.rst
View file
Open in desktop
Expand Up @@ -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::
Expand Down Expand Up @@ -45,4 +51,3 @@ makes it especially useful for those seeking centralized monitoring of distribut
PG/PMAPI
PG/InstrumentingApplications