Merge pull request #32611 from openedx/feanil/platform-docs

feanil/platform docs
openedx · Jul 3, 2023 · 82ee4cd · 82ee4cd
2 parents e543a68 + 8c43868
commit 82ee4cd
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 387 deletions.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 # Do things in edx-platform
-.PHONY: api-docs-sphinx api-docs base-requirements check-types clean \
+.PHONY: base-requirements check-types clean \
   compile-requirements detect_changed_source_translations dev-requirements \
   docker_auth docker_build docker_push docker_tag docs extract_translations \
   guides help lint-imports local-requirements pre-requirements pull \
@@ -23,24 +23,17 @@ clean: ## archive and delete most git-ignored files
 	tar xf $(PRIVATE_FILES)
 	rm $(PRIVATE_FILES)
 
-SWAGGER = docs/swagger.yaml
+SWAGGER = docs/lms-openapi.yaml
 
-docs: api-docs guides technical-docs ## build all the developer documentation for this repository
+docs: guides technical-docs ## build all the developer documentation for this repository
 
 swagger: ## generate the swagger.yaml file
 	DJANGO_SETTINGS_MODULE=docs.docs_settings python manage.py lms generate_swagger --generator-class=edx_api_doc_tools.ApiSchemaGenerator -o $(SWAGGER)
 
-api-docs-sphinx: swagger	## generate the sphinx source files for api-docs
-	rm -f docs/api/gen/*
-	python docs/sw2sphinxopenapi.py $(SWAGGER) docs/api/gen
-
-api-docs: api-docs-sphinx	## build the REST api docs
-	cd docs/api; make html
-
 technical-docs:  ## build the technical docs
 	$(MAKE) -C docs/technical html
 
-guides:	## build the developer guide docs
+guides:	swagger ## build the developer guide docs
 	cd docs/guides; make clean html
 
 extract_translations: ## extract localizable strings from sources

diff --git a/docs/api/.gitignore b/docs/api/.gitignore
diff --git a/docs/api/Makefile b/docs/api/Makefile
diff --git a/docs/api/__init__.py b/docs/api/__init__.py
diff --git a/docs/api/conf.py b/docs/api/conf.py
diff --git a/docs/api/index.rst b/docs/api/index.rst
diff --git a/docs/guides/conf.py b/docs/guides/conf.py
@@ -59,6 +59,7 @@
     '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
@@ -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
@@ -0,0 +1,7 @@
+LMS APIs
+########
+
+The LMS currently has the following API Endpoints.
+
+
+.. openapi:: ../lms-openapi.yaml
diff --git a/docs/swagger.yaml → docs/lms-openapi.yaml b/docs/swagger.yaml → docs/lms-openapi.yaml