feat!: Move the docs out of the guides subdirectory.
Now that the content in `guides` is all of the edx-platform docs, move them all into the top-level docs directory to reduce confusion. BREAKING CHANGE: Guides are now just docs. This will require updating the publishing settings so that RTD looks for the conf in a different location.
This commit is contained in:
14
docs/references/docstrings/cms_index.rst
Normal file
14
docs/references/docstrings/cms_index.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
cms
|
||||
***
|
||||
|
||||
The ``cms`` (course management system) directory in edx-platform is home to
|
||||
the code needed for the Course Authoring Studio which is not also needed for
|
||||
the LMS.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cms/modules
|
||||
cms/djangoapps/contentstore/modules
|
||||
cms/djangoapps/course_creators/modules
|
||||
cms/djangoapps/xblock_config/modules
|
||||
23
docs/references/docstrings/common_djangoapps.rst
Normal file
23
docs/references/docstrings/common_djangoapps.rst
Normal file
@@ -0,0 +1,23 @@
|
||||
common/djangoapps
|
||||
*****************
|
||||
|
||||
This directory contains Django applications intended to be used in both the
|
||||
LMS and Studio.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
common/djangoapps/course_action_state/modules
|
||||
common/djangoapps/course_modes/modules
|
||||
common/djangoapps/database_fixups/modules
|
||||
common/djangoapps/edxmako/modules
|
||||
common/djangoapps/enrollment/modules
|
||||
common/djangoapps/entitlements/modules
|
||||
common/djangoapps/pipeline_mako/modules
|
||||
common/djangoapps/static_replace/modules
|
||||
common/djangoapps/status/modules
|
||||
common/djangoapps/student/modules
|
||||
common/djangoapps/third_party_auth/modules
|
||||
common/djangoapps/track/modules
|
||||
common/djangoapps/util/modules
|
||||
common/djangoapps/xblock_django/modules
|
||||
13
docs/references/docstrings/common_index.rst
Normal file
13
docs/references/docstrings/common_index.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
common
|
||||
******
|
||||
|
||||
The ``common`` directory in edx-platform is home to an assortment of packages
|
||||
used by the LMS and Studio. This is a legacy code organization decision, and
|
||||
it is currently intended that most of the code here will eventually either be
|
||||
moved into the ``openedx`` package or broken out into a separately installed
|
||||
package.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
common/common
|
||||
11
docs/references/docstrings/index.rst
Normal file
11
docs/references/docstrings/index.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
Python Docstrings
|
||||
*****************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cms_index
|
||||
common_index
|
||||
lms_index
|
||||
openedx/modules
|
||||
xmodule/modules
|
||||
22
docs/references/docstrings/lms_index.rst
Normal file
22
docs/references/docstrings/lms_index.rst
Normal file
@@ -0,0 +1,22 @@
|
||||
lms
|
||||
***
|
||||
|
||||
The ``lms`` directory in edx-platform is home to the code needed for the LMS
|
||||
(Learning Management System) which is not also needed for the Course Authoring
|
||||
Studio.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lms/modules
|
||||
lms/djangoapps/badges/modules
|
||||
lms/djangoapps/branding/modules
|
||||
lms/djangoapps/bulk_email/modules
|
||||
lms/djangoapps/courseware/modules
|
||||
lms/djangoapps/coursewarehistoryextended/modules
|
||||
lms/djangoapps/experiments/modules
|
||||
lms/djangoapps/lti_provider/modules
|
||||
lms/djangoapps/mobile_api/modules
|
||||
lms/djangoapps/notes/modules
|
||||
lms/djangoapps/rss_proxy/modules
|
||||
lms/djangoapps/survey/modules
|
||||
8
docs/references/featuretoggles.rst
Normal file
8
docs/references/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/references/index.rst
Normal file
9
docs/references/index.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
References
|
||||
##########
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
*
|
||||
docstrings/index
|
||||
7
docs/references/lms_apis.rst
Normal file
7
docs/references/lms_apis.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
LMS APIs
|
||||
########
|
||||
|
||||
The LMS currently has the following API Endpoints.
|
||||
|
||||
|
||||
.. openapi:: ../../lms-openapi.yaml
|
||||
19
docs/references/settings.rst
Normal file
19
docs/references/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