docs: Generate rst from the existing swagger docs.

Use an existing 3rd party library to generate RST docs from the existing
swagger.yaml file.
This commit is contained in:
Feanil Patel
2023-06-29 15:21:00 -04:00
parent 08e633d57e
commit 56cad59e97
3 changed files with 9 additions and 0 deletions

View File

@@ -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.

View File

@@ -24,6 +24,7 @@ locations.
.. toctree::
:maxdepth: 2
lms_apis
guides
docstrings/docstrings
celery

7
docs/guides/lms_apis.rst Normal file
View File

@@ -0,0 +1,7 @@
LMS APIs
########
The LMS currently has the following API Endpoints.
.. openapi:: ../swagger.yaml