Rename "featuretoggles" docs target to "technical"
We also split the feature toggle and settings docs in different pages.
This commit is contained in:
6
Makefile
6
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
|
||||
|
||||
@@ -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::
|
||||
@@ -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 = ""
|
||||
8
docs/technical/featuretoggles.rst
Normal file
8
docs/technical/featuretoggles.rst
Normal file
@@ -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::
|
||||
9
docs/technical/index.rst
Normal file
9
docs/technical/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
====================================
|
||||
``edx-platform`` technical reference
|
||||
====================================
|
||||
|
||||
This is the technical documentation reference for edx-platform.
|
||||
|
||||
.. toctree::
|
||||
settings
|
||||
featuretoggles
|
||||
19
docs/technical/settings.rst
Normal file
19
docs/technical/settings.rst
Normal file
@@ -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 <featuretoggles>` section.
|
||||
|
||||
LMS settings
|
||||
------------
|
||||
|
||||
.. settings::
|
||||
:folder_path: lms/envs/common.py
|
||||
|
||||
CMS settings
|
||||
------------
|
||||
|
||||
.. settings::
|
||||
:folder_path: cms/envs/common.py
|
||||
Reference in New Issue
Block a user