Files
edx-platform/docs/Makefile
Feanil Patel 3e2d78b37b 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.
2023-07-18 14:31:49 -04:00

31 lines
986 B
Makefile

# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.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)
update_redirects:
# This updates redirects.txt, creating redirects for any files that have moved (relative to master).
sphinx-build -b rediraffewritediff "$(SOURCEDIR)" "$(BUILDDIR)"
check_redirects:
# Check to make sure that any files that got moved have a redirect in redirects.txt
sphinx-build -b rediraffecheckdiff "$(SOURCEDIR)" "$(BUILDDIR)"