From dcebcc4d0d6364d64cbf7da324e5013828941fba Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Fri, 30 Jun 2023 09:33:50 -0400 Subject: [PATCH] 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. --- docs/guides/.gitignore | 9 +++++---- docs/guides/conf.py | 9 +++++---- docs/guides/{ => references}/docstrings/cms_index.rst | 0 .../{ => references}/docstrings/common_djangoapps.rst | 0 docs/guides/{ => references}/docstrings/common_index.rst | 3 +-- .../docstrings.rst => references/docstrings/index.rst} | 0 docs/guides/{ => references}/docstrings/lms_index.rst | 0 docs/guides/references/index.rst | 1 + 8 files changed, 12 insertions(+), 10 deletions(-) rename docs/guides/{ => references}/docstrings/cms_index.rst (100%) rename docs/guides/{ => references}/docstrings/common_djangoapps.rst (100%) rename docs/guides/{ => references}/docstrings/common_index.rst (90%) rename docs/guides/{docstrings/docstrings.rst => references/docstrings/index.rst} (100%) rename docs/guides/{ => references}/docstrings/lms_index.rst (100%) diff --git a/docs/guides/.gitignore b/docs/guides/.gitignore index a77dad836c..3d5538b288 100644 --- a/docs/guides/.gitignore +++ b/docs/guides/.gitignore @@ -1,5 +1,6 @@ _build -cms -common -lms -openedx +references/docstrings/cms +references/docstrings/common +references/docstrings/lms +references/docstrings/openedx +references/docstrings/xmodule diff --git a/docs/guides/conf.py b/docs/guides/conf.py index aa8b0bb073..d4d8dc7897 100644 --- a/docs/guides/conf.py +++ b/docs/guides/conf.py @@ -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', } diff --git a/docs/guides/docstrings/cms_index.rst b/docs/guides/references/docstrings/cms_index.rst similarity index 100% rename from docs/guides/docstrings/cms_index.rst rename to docs/guides/references/docstrings/cms_index.rst diff --git a/docs/guides/docstrings/common_djangoapps.rst b/docs/guides/references/docstrings/common_djangoapps.rst similarity index 100% rename from docs/guides/docstrings/common_djangoapps.rst rename to docs/guides/references/docstrings/common_djangoapps.rst diff --git a/docs/guides/docstrings/common_index.rst b/docs/guides/references/docstrings/common_index.rst similarity index 90% rename from docs/guides/docstrings/common_index.rst rename to docs/guides/references/docstrings/common_index.rst index f2c6d9a7a9..ce3e05c45a 100644 --- a/docs/guides/docstrings/common_index.rst +++ b/docs/guides/references/docstrings/common_index.rst @@ -10,5 +10,4 @@ package. .. toctree:: :maxdepth: 2 - common_djangoapps - common_lib + common/common diff --git a/docs/guides/docstrings/docstrings.rst b/docs/guides/references/docstrings/index.rst similarity index 100% rename from docs/guides/docstrings/docstrings.rst rename to docs/guides/references/docstrings/index.rst diff --git a/docs/guides/docstrings/lms_index.rst b/docs/guides/references/docstrings/lms_index.rst similarity index 100% rename from docs/guides/docstrings/lms_index.rst rename to docs/guides/references/docstrings/lms_index.rst diff --git a/docs/guides/references/index.rst b/docs/guides/references/index.rst index 7d7821ed23..d1a1af3986 100644 --- a/docs/guides/references/index.rst +++ b/docs/guides/references/index.rst @@ -6,3 +6,4 @@ References :glob: * + docstrings/index