docs: Make the generated docs visible.

There is still a lot of improvements that could be made to make the
generated docs better organized.  However, before this change we were
generating the docs but they weren't in the doc tree so you couldn't
actually browse to them.  So we fix that first so that we can start
getting feedback about how to organize them.
This commit is contained in:
Feanil Patel
2023-06-30 09:33:50 -04:00
parent 50f164a6ff
commit dcebcc4d0d
8 changed files with 12 additions and 10 deletions

View 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

View 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

View 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

View File

@@ -0,0 +1,11 @@
Python Docstrings
*****************
.. toctree::
:maxdepth: 2
cms_index
common_index
lms_index
openedx/modules
xmodule/modules

View 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