diff --git a/docs/technical/.gitignore b/docs/technical/.gitignore deleted file mode 100644 index e35d8850c968..000000000000 --- a/docs/technical/.gitignore +++ /dev/null @@ -1 +0,0 @@ -_build diff --git a/docs/technical/Makefile b/docs/technical/Makefile deleted file mode 100644 index c7271eadef5b..000000000000 --- a/docs/technical/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# 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) diff --git a/docs/technical/conf.py b/docs/technical/conf.py deleted file mode 100644 index 3b369152173b..000000000000 --- a/docs/technical/conf.py +++ /dev/null @@ -1,85 +0,0 @@ -""" -Configuration file for the generation of technical documentation. -""" -import os -from datetime import datetime - -import git - -# -- Project information ----------------------------------------------------- - -project = "edx-platform Technical Reference" -copyright = f"{datetime.now().year}, Axim Collaborative, Inc" # pylint: disable=redefined-builtin -author = "Axim Collaborative, Inc" -release = "" - -# -- General configuration --------------------------------------------------- - -extensions = [ - "code_annotations.contrib.sphinx.extensions.featuretoggles", - "code_annotations.contrib.sphinx.extensions.settings", - "sphinx_reredirects", -] - -redirects = { - "*": "https://docs.openedx.org/projects/edx-platform/en/latest/$source.html", -} - -templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - -edxplatform_repo_url = "https://github.com/openedx/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 = "sphinx_book_theme" -html_static_path = ["_static"] -html_favicon = "https://logos.openedx.org/open-edx-favicon.ico" -html_logo = "https://logos.openedx.org/open-edx-logo-color.png" - -html_theme_options = { - "repository_url": "https://github.com/openedx/edx-platform", - "repository_branch": "master", - "path_to_docs": "docs/technical", - "home_page_in_toc": True, - "use_repository_button": True, - "use_issues_button": True, - "use_edit_page_button": True, - # Please don't change unless you know what you're doing. - "extra_footer": """ - - Creative Commons License - -
- These works by - Axim Collaborative, Inc - are licensed under a - Creative Commons Attribution-ShareAlike 4.0 International License. - """, -} diff --git a/docs/technical/featuretoggles.rst b/docs/technical/featuretoggles.rst deleted file mode 100644 index 6c697e50147c..000000000000 --- a/docs/technical/featuretoggles.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _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 deleted file mode 100644 index db8843c4ceb2..000000000000 --- a/docs/technical/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -==================================== -``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 deleted file mode 100644 index 79b366e990e6..000000000000 --- a/docs/technical/settings.rst +++ /dev/null @@ -1,19 +0,0 @@ -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