diff --git a/Makefile b/Makefile index 47e19bfe7b..537162e48a 100644 --- a/Makefile +++ b/Makefile @@ -21,7 +21,7 @@ clean: ## archive and delete most git-ignored files SWAGGER = docs/swagger.yaml -docs: api-docs guides feature-toggles-docs ## build all the developer documentation for this repository +docs: api-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) @@ -33,8 +33,8 @@ api-docs-sphinx: swagger ## generate the sphinx source files for api-docs api-docs: api-docs-sphinx ## build the REST api docs cd docs/api; make html -feature-toggles-docs: - $(MAKE) -C docs/featuretoggles html +technical-docs: ## build the technical docs + $(MAKE) -C docs/technical html guides: ## build the developer guide docs cd docs/guides; make clean html diff --git a/docs/featuretoggles/index.rst b/docs/featuretoggles/index.rst deleted file mode 100644 index b246c4e5c4..0000000000 --- a/docs/featuretoggles/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -Open edX Django settings -======================== - -This is the list of Django settings defined in the ``common.py`` modules of edx-platform. - -LMS settings ------------- - -.. TODO move this to a dedicated page -.. settings:: - :folder_path: lms/envs/common.py - -CMS settings ------------- - -.. settings:: - :folder_path: cms/envs/common.py - - -Open edX Feature Toggles -======================== - -This is the list of all Open edX feature toggles used in edx-platform. These feature toggles can be used to enable or disable features manually on every platform. - -.. featuretoggles:: diff --git a/docs/featuretoggles/.gitignore b/docs/technical/.gitignore similarity index 100% rename from docs/featuretoggles/.gitignore rename to docs/technical/.gitignore diff --git a/docs/featuretoggles/Makefile b/docs/technical/Makefile similarity index 100% rename from docs/featuretoggles/Makefile rename to docs/technical/Makefile diff --git a/docs/featuretoggles/conf.py b/docs/technical/conf.py similarity index 92% rename from docs/featuretoggles/conf.py rename to docs/technical/conf.py index 63e23d526e..cafdfc9e75 100644 --- a/docs/featuretoggles/conf.py +++ b/docs/technical/conf.py @@ -1,5 +1,5 @@ """ -Configuration file for the generation of feature toggle documentation. +Configuration file for the generation of technical documentation. """ import os @@ -8,7 +8,7 @@ import git # -- Project information ----------------------------------------------------- -project = "Open edX feature toggles" +project = "edx-platform technical reference" copyright = edx_theme.COPYRIGHT # pylint: disable=redefined-builtin author = edx_theme.AUTHOR release = "" diff --git a/docs/technical/featuretoggles.rst b/docs/technical/featuretoggles.rst new file mode 100644 index 0000000000..6c697e5014 --- /dev/null +++ b/docs/technical/featuretoggles.rst @@ -0,0 +1,8 @@ +.. _featuretoggles: + +Feature Toggles +=============== + +This is the list of all Open edX feature toggles used in edx-platform. These feature toggles can be used to enable or disable features manually on every platform. + +.. featuretoggles:: diff --git a/docs/technical/index.rst b/docs/technical/index.rst new file mode 100644 index 0000000000..db8843c4ce --- /dev/null +++ b/docs/technical/index.rst @@ -0,0 +1,9 @@ +==================================== +``edx-platform`` technical reference +==================================== + +This is the technical documentation reference for edx-platform. + +.. toctree:: + settings + featuretoggles diff --git a/docs/technical/settings.rst b/docs/technical/settings.rst new file mode 100644 index 0000000000..79b366e990 --- /dev/null +++ b/docs/technical/settings.rst @@ -0,0 +1,19 @@ +Settings +======== + +This is the list of (non-toggle) Django settings defined in the ``common.py`` modules of edx-platform. + +.. note:: + Toggle settings, which enable or disable a specific feature, are documented in the :ref:`feature toggles ` section. + +LMS settings +------------ + +.. settings:: + :folder_path: lms/envs/common.py + +CMS settings +------------ + +.. settings:: + :folder_path: cms/envs/common.py