Merge pull request #32780 from openedx/feanil/unify_docs

feanil/unify docs
openedx · Jul 19, 2023 · 686cab0 · 686cab0
2 parents 3af1ce0 + de6639a
commit 686cab0
Show file tree

Hide file tree

Showing 39 changed files with 10 additions and 150 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -5,6 +5,9 @@ build:
   tools:
     python: "3.8"
 
+sphinx:
+  configuration: source/conf.py
+
 python:
   install:
   - requirements: "requirements/edx/doc.txt"

diff --git a/docs/guides/.gitignore → docs/.gitignore b/docs/guides/.gitignore → docs/.gitignore
diff --git a/docs/guides/Makefile → docs/Makefile b/docs/guides/Makefile → docs/Makefile
diff --git a/docs/guides/concepts/extension_points.rst → docs/concepts/extension_points.rst b/docs/guides/concepts/extension_points.rst → docs/concepts/extension_points.rst
diff --git a/docs/guides/concepts/frontend/bootstrap.rst → docs/concepts/frontend/bootstrap.rst b/docs/guides/concepts/frontend/bootstrap.rst → docs/concepts/frontend/bootstrap.rst
diff --git a/docs/guides/concepts/frontend/javascript.rst → docs/concepts/frontend/javascript.rst b/docs/guides/concepts/frontend/javascript.rst → docs/concepts/frontend/javascript.rst
diff --git a/...uides/concepts/frontend/static_assets.rst → docs/concepts/frontend/static_assets.rst b/...uides/concepts/frontend/static_assets.rst → docs/concepts/frontend/static_assets.rst
diff --git a/docs/guides/concepts/frontend/styling.rst → docs/concepts/frontend/styling.rst b/docs/guides/concepts/frontend/styling.rst → docs/concepts/frontend/styling.rst
diff --git a/docs/guides/concepts/index.rst → docs/concepts/index.rst b/docs/guides/concepts/index.rst → docs/concepts/index.rst
diff --git a/.../guides/concepts/testing/test_pyramid.png → docs/concepts/testing/test_pyramid.png b/.../guides/concepts/testing/test_pyramid.png → docs/concepts/testing/test_pyramid.png
diff --git a/docs/guides/concepts/testing/testing.rst → docs/concepts/testing/testing.rst b/docs/guides/concepts/testing/testing.rst → docs/concepts/testing/testing.rst
diff --git a/docs/guides/conf.py → docs/conf.py b/docs/guides/conf.py → docs/conf.py
@@ -16,12 +16,12 @@
 
 from path import Path
 
-root = Path('../..').abspath()
+root = Path('..').abspath()
 
 # Hack the PYTHONPATH to match what LMS and Studio use so all the code
 # can be successfully imported
 sys.path.insert(0, root)
-sys.path.append(root / "docs/guides")
+sys.path.append(root / "docs")
 
 
 # Use a settings module that allows all LMS and Studio code to be imported
@@ -74,9 +74,8 @@
 
 # code_annotations.(featuretoggles|settings) related settings.
 edxplatform_repo_url = "https://github.com/openedx/edx-platform"
-edxplatform_source_path = os.path.abspath(
-    os.path.join(os.path.dirname(__file__), "..", "..")
-)
+edxplatform_source_path = root
+
 try:
     edx_platform_version = git.Repo(search_parent_directories=True).head.object.hexsha
 except git.InvalidGitRepositoryError:
@@ -136,7 +135,7 @@
 html_theme_options = {
     "repository_url": "https://github.com/openedx/edx-platform",
     "repository_branch": "master",
-    "path_to_docs": "docs/guides",
+    "path_to_docs": "docs",
     "home_page_in_toc": True,
     "use_repository_button": True,
     "use_issues_button": True,
@@ -308,7 +307,7 @@ def on_init(app):  # lint-amnesty, pylint: disable=redefined-outer-name, unused-
     Read the Docs won't run tox or custom shell commands, so we need this to
     avoid checking in the generated reStructuredText files.
     """
-    docs_path = root / 'docs' / 'guides'
+    docs_path = root / 'docs'
     apidoc_path = 'sphinx-apidoc'
     if hasattr(sys, 'real_prefix'):  # Check to see if we are in a virtualenv
         # If we are, assemble the path manually

diff --git a/docs/guides/extensions/tinymce_plugins.rst → docs/extensions/tinymce_plugins.rst b/docs/guides/extensions/tinymce_plugins.rst → docs/extensions/tinymce_plugins.rst
diff --git a/docs/guides/__init__.py b/docs/guides/__init__.py
diff --git a/docs/guides/hooks/events.rst → docs/hooks/events.rst b/docs/guides/hooks/events.rst → docs/hooks/events.rst
diff --git a/docs/guides/hooks/filters.rst → docs/hooks/filters.rst b/docs/guides/hooks/filters.rst → docs/hooks/filters.rst
diff --git a/docs/guides/hooks/index.rst → docs/hooks/index.rst b/docs/guides/hooks/index.rst → docs/hooks/index.rst
diff --git a/docs/guides/how-tos/celery.rst → docs/how-tos/celery.rst b/docs/guides/how-tos/celery.rst → docs/how-tos/celery.rst
diff --git a/docs/guides/how-tos/index.rst → docs/how-tos/index.rst b/docs/guides/how-tos/index.rst → docs/how-tos/index.rst
diff --git a/docs/guides/index.rst → docs/index.rst b/docs/guides/index.rst → docs/index.rst
diff --git a/docs/guides/make.bat → docs/make.bat b/docs/guides/make.bat → docs/make.bat
diff --git a/docs/guides/redirects.txt → docs/redirects.txt b/docs/guides/redirects.txt → docs/redirects.txt
diff --git a/...uides/references/docstrings/cms_index.rst → docs/references/docstrings/cms_index.rst b/...uides/references/docstrings/cms_index.rst → docs/references/docstrings/cms_index.rst
diff --git a/...ferences/docstrings/common_djangoapps.rst → ...ferences/docstrings/common_djangoapps.rst b/...ferences/docstrings/common_djangoapps.rst → ...ferences/docstrings/common_djangoapps.rst
diff --git a/...es/references/docstrings/common_index.rst → docs/references/docstrings/common_index.rst b/...es/references/docstrings/common_index.rst → docs/references/docstrings/common_index.rst
diff --git a/docs/guides/references/docstrings/index.rst → docs/references/docstrings/index.rst b/docs/guides/references/docstrings/index.rst → docs/references/docstrings/index.rst
diff --git a/...uides/references/docstrings/lms_index.rst → docs/references/docstrings/lms_index.rst b/...uides/references/docstrings/lms_index.rst → docs/references/docstrings/lms_index.rst
diff --git a/docs/guides/references/featuretoggles.rst → docs/references/featuretoggles.rst b/docs/guides/references/featuretoggles.rst → docs/references/featuretoggles.rst
diff --git a/docs/guides/references/index.rst → docs/references/index.rst b/docs/guides/references/index.rst → docs/references/index.rst
diff --git a/docs/guides/references/lms_apis.rst → docs/references/lms_apis.rst b/docs/guides/references/lms_apis.rst → docs/references/lms_apis.rst
@@ -4,4 +4,4 @@ LMS APIs
 The LMS currently has the following API Endpoints.
 
 
-.. openapi:: ../../lms-openapi.yaml
+.. openapi:: ../lms-openapi.yaml
diff --git a/docs/guides/references/settings.rst → docs/references/settings.rst b/docs/guides/references/settings.rst → docs/references/settings.rst
diff --git a/docs/guides/studio_oauth.rst → docs/studio_oauth.rst b/docs/guides/studio_oauth.rst → docs/studio_oauth.rst
diff --git a/docs/technical/.gitignore b/docs/technical/.gitignore
diff --git a/docs/technical/Makefile b/docs/technical/Makefile
diff --git a/docs/technical/conf.py b/docs/technical/conf.py
diff --git a/docs/technical/featuretoggles.rst b/docs/technical/featuretoggles.rst
diff --git a/docs/technical/index.rst b/docs/technical/index.rst
diff --git a/docs/technical/settings.rst b/docs/technical/settings.rst
diff --git a/docs/guides/v1_sass_pipeline.webp → docs/v1_sass_pipeline.webp b/docs/guides/v1_sass_pipeline.webp → docs/v1_sass_pipeline.webp
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@ LMS APIs
		The LMS currently has the following API Endpoints.


		.. openapi:: ../../lms-openapi.yaml
		.. openapi:: ../lms-openapi.yaml