From 3e2d78b37bb9007bd1a81d5626ff817f45b8b403 Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Tue, 18 Jul 2023 14:31:49 -0400 Subject: [PATCH] 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. --- docs/{guides => }/.gitignore | 0 docs/{guides => }/Makefile | 0 docs/{guides => }/concepts/extension_points.rst | 0 docs/{guides => }/concepts/frontend/bootstrap.rst | 0 docs/{guides => }/concepts/frontend/javascript.rst | 0 .../concepts/frontend/static_assets.rst | 0 docs/{guides => }/concepts/frontend/styling.rst | 0 docs/{guides => }/concepts/index.rst | 0 docs/{guides => }/concepts/testing/test_pyramid.png | Bin docs/{guides => }/concepts/testing/testing.rst | 0 docs/{guides => }/conf.py | 0 docs/{guides => }/extensions/tinymce_plugins.rst | 0 docs/guides/__init__.py | 0 docs/{guides => }/hooks/events.rst | 0 docs/{guides => }/hooks/filters.rst | 0 docs/{guides => }/hooks/index.rst | 0 docs/{guides => }/how-tos/celery.rst | 0 docs/{guides => }/how-tos/index.rst | 0 docs/{guides => }/index.rst | 0 docs/{guides => }/make.bat | 0 docs/{guides => }/redirects.txt | 0 .../references/docstrings/cms_index.rst | 0 .../references/docstrings/common_djangoapps.rst | 0 .../references/docstrings/common_index.rst | 0 docs/{guides => }/references/docstrings/index.rst | 0 .../references/docstrings/lms_index.rst | 0 docs/{guides => }/references/featuretoggles.rst | 0 docs/{guides => }/references/index.rst | 0 docs/{guides => }/references/lms_apis.rst | 0 docs/{guides => }/references/settings.rst | 0 docs/{guides => }/studio_oauth.rst | 0 docs/{guides => }/v1_sass_pipeline.webp | Bin 32 files changed, 0 insertions(+), 0 deletions(-) rename docs/{guides => }/.gitignore (100%) rename docs/{guides => }/Makefile (100%) rename docs/{guides => }/concepts/extension_points.rst (100%) rename docs/{guides => }/concepts/frontend/bootstrap.rst (100%) rename docs/{guides => }/concepts/frontend/javascript.rst (100%) rename docs/{guides => }/concepts/frontend/static_assets.rst (100%) rename docs/{guides => }/concepts/frontend/styling.rst (100%) rename docs/{guides => }/concepts/index.rst (100%) rename docs/{guides => }/concepts/testing/test_pyramid.png (100%) rename docs/{guides => }/concepts/testing/testing.rst (100%) rename docs/{guides => }/conf.py (100%) rename docs/{guides => }/extensions/tinymce_plugins.rst (100%) delete mode 100644 docs/guides/__init__.py rename docs/{guides => }/hooks/events.rst (100%) rename docs/{guides => }/hooks/filters.rst (100%) rename docs/{guides => }/hooks/index.rst (100%) rename docs/{guides => }/how-tos/celery.rst (100%) rename docs/{guides => }/how-tos/index.rst (100%) rename docs/{guides => }/index.rst (100%) rename docs/{guides => }/make.bat (100%) rename docs/{guides => }/redirects.txt (100%) 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 (100%) rename docs/{guides => }/references/docstrings/index.rst (100%) rename docs/{guides => }/references/docstrings/lms_index.rst (100%) rename docs/{guides => }/references/featuretoggles.rst (100%) rename docs/{guides => }/references/index.rst (100%) rename docs/{guides => }/references/lms_apis.rst (100%) rename docs/{guides => }/references/settings.rst (100%) rename docs/{guides => }/studio_oauth.rst (100%) rename docs/{guides => }/v1_sass_pipeline.webp (100%) diff --git a/docs/guides/.gitignore b/docs/.gitignore similarity index 100% rename from docs/guides/.gitignore rename to docs/.gitignore diff --git a/docs/guides/Makefile b/docs/Makefile similarity index 100% rename from docs/guides/Makefile rename to docs/Makefile diff --git a/docs/guides/concepts/extension_points.rst b/docs/concepts/extension_points.rst similarity index 100% rename from docs/guides/concepts/extension_points.rst rename to docs/concepts/extension_points.rst diff --git a/docs/guides/concepts/frontend/bootstrap.rst b/docs/concepts/frontend/bootstrap.rst similarity index 100% rename from docs/guides/concepts/frontend/bootstrap.rst rename to docs/concepts/frontend/bootstrap.rst diff --git a/docs/guides/concepts/frontend/javascript.rst b/docs/concepts/frontend/javascript.rst similarity index 100% rename from docs/guides/concepts/frontend/javascript.rst rename to docs/concepts/frontend/javascript.rst diff --git a/docs/guides/concepts/frontend/static_assets.rst b/docs/concepts/frontend/static_assets.rst similarity index 100% rename from docs/guides/concepts/frontend/static_assets.rst rename to docs/concepts/frontend/static_assets.rst diff --git a/docs/guides/concepts/frontend/styling.rst b/docs/concepts/frontend/styling.rst similarity index 100% rename from docs/guides/concepts/frontend/styling.rst rename to docs/concepts/frontend/styling.rst diff --git a/docs/guides/concepts/index.rst b/docs/concepts/index.rst similarity index 100% rename from docs/guides/concepts/index.rst rename to docs/concepts/index.rst diff --git a/docs/guides/concepts/testing/test_pyramid.png b/docs/concepts/testing/test_pyramid.png similarity index 100% rename from docs/guides/concepts/testing/test_pyramid.png rename to docs/concepts/testing/test_pyramid.png diff --git a/docs/guides/concepts/testing/testing.rst b/docs/concepts/testing/testing.rst similarity index 100% rename from docs/guides/concepts/testing/testing.rst rename to docs/concepts/testing/testing.rst diff --git a/docs/guides/conf.py b/docs/conf.py similarity index 100% rename from docs/guides/conf.py rename to docs/conf.py diff --git a/docs/guides/extensions/tinymce_plugins.rst b/docs/extensions/tinymce_plugins.rst similarity index 100% rename from docs/guides/extensions/tinymce_plugins.rst rename to docs/extensions/tinymce_plugins.rst diff --git a/docs/guides/__init__.py b/docs/guides/__init__.py deleted file mode 100644 index e69de29bb2d1..000000000000 diff --git a/docs/guides/hooks/events.rst b/docs/hooks/events.rst similarity index 100% rename from docs/guides/hooks/events.rst rename to docs/hooks/events.rst diff --git a/docs/guides/hooks/filters.rst b/docs/hooks/filters.rst similarity index 100% rename from docs/guides/hooks/filters.rst rename to docs/hooks/filters.rst diff --git a/docs/guides/hooks/index.rst b/docs/hooks/index.rst similarity index 100% rename from docs/guides/hooks/index.rst rename to docs/hooks/index.rst diff --git a/docs/guides/how-tos/celery.rst b/docs/how-tos/celery.rst similarity index 100% rename from docs/guides/how-tos/celery.rst rename to docs/how-tos/celery.rst diff --git a/docs/guides/how-tos/index.rst b/docs/how-tos/index.rst similarity index 100% rename from docs/guides/how-tos/index.rst rename to docs/how-tos/index.rst diff --git a/docs/guides/index.rst b/docs/index.rst similarity index 100% rename from docs/guides/index.rst rename to docs/index.rst diff --git a/docs/guides/make.bat b/docs/make.bat similarity index 100% rename from docs/guides/make.bat rename to docs/make.bat diff --git a/docs/guides/redirects.txt b/docs/redirects.txt similarity index 100% rename from docs/guides/redirects.txt rename to docs/redirects.txt diff --git a/docs/guides/references/docstrings/cms_index.rst b/docs/references/docstrings/cms_index.rst similarity index 100% rename from docs/guides/references/docstrings/cms_index.rst rename to docs/references/docstrings/cms_index.rst diff --git a/docs/guides/references/docstrings/common_djangoapps.rst b/docs/references/docstrings/common_djangoapps.rst similarity index 100% rename from docs/guides/references/docstrings/common_djangoapps.rst rename to docs/references/docstrings/common_djangoapps.rst diff --git a/docs/guides/references/docstrings/common_index.rst b/docs/references/docstrings/common_index.rst similarity index 100% rename from docs/guides/references/docstrings/common_index.rst rename to docs/references/docstrings/common_index.rst diff --git a/docs/guides/references/docstrings/index.rst b/docs/references/docstrings/index.rst similarity index 100% rename from docs/guides/references/docstrings/index.rst rename to docs/references/docstrings/index.rst diff --git a/docs/guides/references/docstrings/lms_index.rst b/docs/references/docstrings/lms_index.rst similarity index 100% rename from docs/guides/references/docstrings/lms_index.rst rename to docs/references/docstrings/lms_index.rst diff --git a/docs/guides/references/featuretoggles.rst b/docs/references/featuretoggles.rst similarity index 100% rename from docs/guides/references/featuretoggles.rst rename to docs/references/featuretoggles.rst diff --git a/docs/guides/references/index.rst b/docs/references/index.rst similarity index 100% rename from docs/guides/references/index.rst rename to docs/references/index.rst diff --git a/docs/guides/references/lms_apis.rst b/docs/references/lms_apis.rst similarity index 100% rename from docs/guides/references/lms_apis.rst rename to docs/references/lms_apis.rst diff --git a/docs/guides/references/settings.rst b/docs/references/settings.rst similarity index 100% rename from docs/guides/references/settings.rst rename to docs/references/settings.rst diff --git a/docs/guides/studio_oauth.rst b/docs/studio_oauth.rst similarity index 100% rename from docs/guides/studio_oauth.rst rename to docs/studio_oauth.rst diff --git a/docs/guides/v1_sass_pipeline.webp b/docs/v1_sass_pipeline.webp similarity index 100% rename from docs/guides/v1_sass_pipeline.webp rename to docs/v1_sass_pipeline.webp