Skip to content

Commit

Permalink
docs: Remove the api docs sphinx project.
Browse files Browse the repository at this point in the history
* This project was not being published anywhere.
* The previous commit that adds openapi generation capabilities to the
  `docs/guides` replaces what this was doing.
  • Loading branch information
feanil committed Jun 29, 2023
1 parent 56cad59 commit 2626213
Show file tree
Hide file tree
Showing 7 changed files with 3 additions and 386 deletions.
13 changes: 3 additions & 10 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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 \
Expand All @@ -25,22 +25,15 @@ clean: ## archive and delete most git-ignored files

SWAGGER = docs/swagger.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
Expand Down
2 changes: 0 additions & 2 deletions docs/api/.gitignore

This file was deleted.

19 changes: 0 additions & 19 deletions docs/api/Makefile

This file was deleted.

Empty file removed docs/api/__init__.py
Empty file.
218 changes: 0 additions & 218 deletions docs/api/conf.py

This file was deleted.

11 changes: 0 additions & 11 deletions docs/api/index.rst

This file was deleted.

Loading

0 comments on commit 2626213

Please sign in to comment.