From 3b69fe0b47da784b290ec7363a236462f75a8804 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 23 Jul 2019 07:26:03 -0400 Subject: [PATCH] Move existing docs down a level to make room for more --- .gitignore | 7 ------- Makefile | 3 +-- docs/guides/.gitignore | 5 +++++ docs/{ => guides}/Makefile | 7 +++++-- docs/{ => guides}/__init__.py | 0 docs/{ => guides}/conf.py | 6 +++--- docs/{ => guides}/docs_settings.py | 0 docs/{ => guides}/docstrings/cms_index.rst | 0 docs/{ => guides}/docstrings/common_djangoapps.rst | 0 docs/{ => guides}/docstrings/common_index.rst | 0 docs/{ => guides}/docstrings/common_lib.rst | 0 docs/{ => guides}/docstrings/docstrings.rst | 0 docs/{ => guides}/docstrings/lms_index.rst | 0 docs/{ => guides}/frontend/bootstrap.rst | 0 docs/{ => guides}/frontend/javascript.rst | 0 docs/{ => guides}/frontend/static_assets.rst | 0 docs/{ => guides}/frontend/styling.rst | 0 docs/{ => guides}/guides.rst | 0 docs/{ => guides}/index.rst | 0 docs/{ => guides}/make.bat | 0 docs/{ => guides}/testing/test_pyramid.png | Bin docs/{ => guides}/testing/testing.rst | 0 docs/{ => guides}/v1_sass_pipeline.webp | Bin 23 files changed, 14 insertions(+), 14 deletions(-) create mode 100644 docs/guides/.gitignore rename docs/{ => guides}/Makefile (87%) rename docs/{ => guides}/__init__.py (100%) rename docs/{ => guides}/conf.py (99%) rename docs/{ => guides}/docs_settings.py (100%) rename docs/{ => guides}/docstrings/cms_index.rst (100%) rename docs/{ => guides}/docstrings/common_djangoapps.rst (100%) rename docs/{ => guides}/docstrings/common_index.rst (100%) rename docs/{ => guides}/docstrings/common_lib.rst (100%) rename docs/{ => guides}/docstrings/docstrings.rst (100%) rename docs/{ => guides}/docstrings/lms_index.rst (100%) rename docs/{ => guides}/frontend/bootstrap.rst (100%) rename docs/{ => guides}/frontend/javascript.rst (100%) rename docs/{ => guides}/frontend/static_assets.rst (100%) rename docs/{ => guides}/frontend/styling.rst (100%) rename docs/{ => guides}/guides.rst (100%) rename docs/{ => guides}/index.rst (100%) rename docs/{ => guides}/make.bat (100%) rename docs/{ => guides}/testing/test_pyramid.png (100%) rename docs/{ => guides}/testing/testing.rst (100%) rename docs/{ => guides}/v1_sass_pipeline.webp (100%) diff --git a/.gitignore b/.gitignore index 26775845b4..eb0bc8d037 100644 --- a/.gitignore +++ b/.gitignore @@ -143,10 +143,3 @@ dist # Locally generated PII reports pii_report - -# Local documentation builds -docs/_build -docs/cms -docs/common -docs/lms -docs/openedx diff --git a/Makefile b/Makefile index c9fb8b2987..92d761a8da 100644 --- a/Makefile +++ b/Makefile @@ -19,8 +19,7 @@ clean: ## archive and delete most git-ignored files rm $(PRIVATE_FILES) docs: ## build the developer documentation for this repository - rm -rf docs/_build docs/cms docs/common docs/lms docs/openedx - cd docs; make html + cd docs/guides; make clean html extract_translations: ## extract localizable strings from sources i18n_tool extract -v diff --git a/docs/guides/.gitignore b/docs/guides/.gitignore new file mode 100644 index 0000000000..a77dad836c --- /dev/null +++ b/docs/guides/.gitignore @@ -0,0 +1,5 @@ +_build +cms +common +lms +openedx diff --git a/docs/Makefile b/docs/guides/Makefile similarity index 87% rename from docs/Makefile rename to docs/guides/Makefile index 298ea9e213..ea9c33b5ec 100644 --- a/docs/Makefile +++ b/docs/guides/Makefile @@ -11,9 +11,12 @@ BUILDDIR = _build help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +.PHONY: help clean Makefile + +clean: + rm -rf _build cms common lms openedx # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/__init__.py b/docs/guides/__init__.py similarity index 100% rename from docs/__init__.py rename to docs/guides/__init__.py diff --git a/docs/conf.py b/docs/guides/conf.py similarity index 99% rename from docs/conf.py rename to docs/guides/conf.py index 685d68818b..57068f5a9b 100644 --- a/docs/conf.py +++ b/docs/guides/conf.py @@ -18,12 +18,12 @@ import edx_theme import six 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") +sys.path.append(root / "docs/guides") sys.path.append(root / "cms/djangoapps") sys.path.append(root / "common/djangoapps") sys.path.append(root / "common/lib/capa") @@ -284,7 +284,7 @@ def on_init(app): # pylint: disable=unused-argument 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' + docs_path = root / 'docs' / 'guides' 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/docs_settings.py b/docs/guides/docs_settings.py similarity index 100% rename from docs/docs_settings.py rename to docs/guides/docs_settings.py diff --git a/docs/docstrings/cms_index.rst b/docs/guides/docstrings/cms_index.rst similarity index 100% rename from docs/docstrings/cms_index.rst rename to docs/guides/docstrings/cms_index.rst diff --git a/docs/docstrings/common_djangoapps.rst b/docs/guides/docstrings/common_djangoapps.rst similarity index 100% rename from docs/docstrings/common_djangoapps.rst rename to docs/guides/docstrings/common_djangoapps.rst diff --git a/docs/docstrings/common_index.rst b/docs/guides/docstrings/common_index.rst similarity index 100% rename from docs/docstrings/common_index.rst rename to docs/guides/docstrings/common_index.rst diff --git a/docs/docstrings/common_lib.rst b/docs/guides/docstrings/common_lib.rst similarity index 100% rename from docs/docstrings/common_lib.rst rename to docs/guides/docstrings/common_lib.rst diff --git a/docs/docstrings/docstrings.rst b/docs/guides/docstrings/docstrings.rst similarity index 100% rename from docs/docstrings/docstrings.rst rename to docs/guides/docstrings/docstrings.rst diff --git a/docs/docstrings/lms_index.rst b/docs/guides/docstrings/lms_index.rst similarity index 100% rename from docs/docstrings/lms_index.rst rename to docs/guides/docstrings/lms_index.rst diff --git a/docs/frontend/bootstrap.rst b/docs/guides/frontend/bootstrap.rst similarity index 100% rename from docs/frontend/bootstrap.rst rename to docs/guides/frontend/bootstrap.rst diff --git a/docs/frontend/javascript.rst b/docs/guides/frontend/javascript.rst similarity index 100% rename from docs/frontend/javascript.rst rename to docs/guides/frontend/javascript.rst diff --git a/docs/frontend/static_assets.rst b/docs/guides/frontend/static_assets.rst similarity index 100% rename from docs/frontend/static_assets.rst rename to docs/guides/frontend/static_assets.rst diff --git a/docs/frontend/styling.rst b/docs/guides/frontend/styling.rst similarity index 100% rename from docs/frontend/styling.rst rename to docs/guides/frontend/styling.rst diff --git a/docs/guides.rst b/docs/guides/guides.rst similarity index 100% rename from docs/guides.rst rename to docs/guides/guides.rst diff --git a/docs/index.rst b/docs/guides/index.rst similarity index 100% rename from docs/index.rst rename to docs/guides/index.rst diff --git a/docs/make.bat b/docs/guides/make.bat similarity index 100% rename from docs/make.bat rename to docs/guides/make.bat diff --git a/docs/testing/test_pyramid.png b/docs/guides/testing/test_pyramid.png similarity index 100% rename from docs/testing/test_pyramid.png rename to docs/guides/testing/test_pyramid.png diff --git a/docs/testing/testing.rst b/docs/guides/testing/testing.rst similarity index 100% rename from docs/testing/testing.rst rename to docs/guides/testing/testing.rst diff --git a/docs/v1_sass_pipeline.webp b/docs/guides/v1_sass_pipeline.webp similarity index 100% rename from docs/v1_sass_pipeline.webp rename to docs/guides/v1_sass_pipeline.webp