Adds the ability to override the doc build output directory from the command line. (#36604)

* Adds the ability to override the doc build output from the command line.

* For safety, removed straight rm of BUILDDIR and removed subdirectories instead.

* Added check to see if BUILDDIR was defined to main makefile
This commit is contained in:
scottb 2018-02-28 16:01:18 -08:00 committed by GitHub
parent 4a6758b74f
commit f923299fe8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 3 deletions

View file

@ -11,6 +11,11 @@ else
CPUS ?= $(shell nproc) CPUS ?= $(shell nproc)
endif endif
# Sets the build output directory if it's not already specified
ifndef BUILDDIR
BUILDDIR = _build
endif
MODULE_ARGS= MODULE_ARGS=
ifdef MODULES ifdef MODULES
MODULE_ARGS = -l $(MODULES) MODULE_ARGS = -l $(MODULES)
@ -44,6 +49,9 @@ webdocs: docs
#TODO: leaving htmlout removal for those having older versions, should eventually be removed also #TODO: leaving htmlout removal for those having older versions, should eventually be removed also
clean: clean:
@echo "Cleaning $(BUILDDIR)"
-rm -rf $(BUILDDIR)/doctrees
-rm -rf $(BUILDDIR)/html
-rm -rf htmlout -rm -rf htmlout
-rm -rf module_docs -rm -rf module_docs
-rm -rf _build -rm -rf _build
@ -103,5 +111,5 @@ epub:
(CPUS=$(CPUS) make -f Makefile.sphinx epub) (CPUS=$(CPUS) make -f Makefile.sphinx epub)
htmlsingle: assertrst htmlsingle: assertrst
sphinx-build -j $(CPUS) -b html -d _build/doctrees ./rst _build/html rst/$(rst) sphinx-build -j $(CPUS) -b html -d $(BUILDDIR)/doctrees ./rst $(BUILDDIR)/html rst/$(rst)
@echo "Output is in _build/html/$(rst:.rst=.html)" @echo "Output is in $(BUILDDIR)/$(rst:.rst=.html)"

View file

@ -6,7 +6,11 @@ SPHINXOPTS = -j $(CPUS) -n -w rst_warnings
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
SPHINXPROJ = sdfsdf SPHINXPROJ = sdfsdf
SOURCEDIR = rst SOURCEDIR = rst
# Sets the build output directory if it's not specified on the command line
ifndef BUILDDIR
BUILDDIR = _build BUILDDIR = _build
endif
# Put it first so that "make" without argument is like "make help". # Put it first so that "make" without argument is like "make help".
help: help: