From 56cad59e977083effd0a327a5ff83e3970f8cb60 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Thu, 29 Jun 2023 15:21:00 -0400 Subject: [PATCH] docs: Generate rst from the existing swagger docs. Use an existing 3rd party library to generate RST docs from the existing swagger.yaml file. --- docs/guides/conf.py | 1 + docs/guides/index.rst | 1 + docs/guides/lms_apis.rst | 7 +++++++ 3 files changed, 9 insertions(+) create mode 100644 docs/guides/lms_apis.rst diff --git a/docs/guides/conf.py b/docs/guides/conf.py index 64b38a283a..f0491d5598 100644 --- a/docs/guides/conf.py +++ b/docs/guides/conf.py @@ -59,6 +59,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.napoleon', + 'sphinxcontrib.openapi', ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/guides/index.rst b/docs/guides/index.rst index 0946a37c38..371fce5586 100644 --- a/docs/guides/index.rst +++ b/docs/guides/index.rst @@ -24,6 +24,7 @@ locations. .. toctree:: :maxdepth: 2 + lms_apis guides docstrings/docstrings celery diff --git a/docs/guides/lms_apis.rst b/docs/guides/lms_apis.rst new file mode 100644 index 0000000000..86684ec025 --- /dev/null +++ b/docs/guides/lms_apis.rst @@ -0,0 +1,7 @@ +LMS APIs +######## + +The LMS currently has the following API Endpoints. + + +.. openapi:: ../swagger.yaml