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

@@ -1,5 +1,6 @@
_build
cms
common
lms
openedx
references/docstrings/cms
references/docstrings/common
references/docstrings/lms
references/docstrings/openedx
references/docstrings/xmodule

View File

@@ -273,10 +273,11 @@ autodoc_mock_imports = [
# run sphinx-apidoc against and the directories under "docs" in which to store
# the generated *.rst files
modules = {
'cms': 'cms',
'lms': 'lms',
'openedx': 'openedx',
'xmodule': 'xmodule',
'cms': 'references/docstrings/cms',
'lms': 'references/docstrings/lms',
'openedx': 'references/docstrings/openedx',
'common': 'references/docstrings/common',
'xmodule': 'references/docstrings/xmodule',
}

View File

@@ -10,5 +10,4 @@ package.
.. toctree::
:maxdepth: 2
common_djangoapps
common_lib
common/common

View File

@@ -6,3 +6,4 @@ References
:glob:
*
docstrings/index