Merge pull request #21191 from edx/nedbat/more-docs

Move existing docs down a level to make room for more

.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

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

docs/guides/.gitignore

@@ -0,0 +1,5 @@
+_build
+cms
+common
+lms
+openedx

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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

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