Rename "featuretoggles" docs target to "technical"
We also split the feature toggle and settings docs in different pages.
This commit is contained in:
1
docs/technical/.gitignore
vendored
Normal file
1
docs/technical/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
_build
|
||||
20
docs/technical/Makefile
Normal file
20
docs/technical/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
43
docs/technical/conf.py
Normal file
43
docs/technical/conf.py
Normal file
@@ -0,0 +1,43 @@
|
||||
"""
|
||||
Configuration file for the generation of technical documentation.
|
||||
"""
|
||||
import os
|
||||
|
||||
import edx_theme
|
||||
import git
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = "edx-platform technical reference"
|
||||
copyright = edx_theme.COPYRIGHT # pylint: disable=redefined-builtin
|
||||
author = edx_theme.AUTHOR
|
||||
release = ""
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
extensions = ["code_annotations.contrib.sphinx.extensions.featuretoggles", "code_annotations.contrib.sphinx.extensions.settings"]
|
||||
templates_path = ["_templates"]
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
edxplatform_repo_url = "https://github.com/edx/edx-platform"
|
||||
edxplatform_source_path = os.path.abspath(
|
||||
os.path.join(os.path.dirname(__file__), "..", "..")
|
||||
)
|
||||
try:
|
||||
edx_platform_version = git.Repo(search_parent_directories=True).head.object.hexsha
|
||||
except git.InvalidGitRepositoryError:
|
||||
edx_platform_version = "master"
|
||||
|
||||
featuretoggles_source_path = edxplatform_source_path
|
||||
featuretoggles_repo_url = edxplatform_repo_url
|
||||
featuretoggles_repo_version = edx_platform_version
|
||||
|
||||
settings_source_path = edxplatform_source_path
|
||||
settings_repo_url = edxplatform_repo_url
|
||||
settings_repo_version = edx_platform_version
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
html_theme = "edx_theme"
|
||||
html_theme_path = [edx_theme.get_html_theme_path()]
|
||||
html_static_path = ["_static"]
|
||||
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