xref: /petsc/doc/makefile (revision 4754a72fd8063cbcf223a31c4aa7e275b1cfa837)
1*4754a72fSPatrick Sanan# Initially generated with sphinx-quickstart
2*4754a72fSPatrick Sanan
3*4754a72fSPatrick Sanan# You can set these variables from the command line, and also
4*4754a72fSPatrick Sanan# from the environment for the first two.
5*4754a72fSPatrick SananSPHINXOPTS    ?=
6*4754a72fSPatrick SananSPHINXBUILD   ?= sphinx-build
7*4754a72fSPatrick SananSOURCEDIR     = .
8*4754a72fSPatrick SananBUILDDIR      = _build
9*4754a72fSPatrick SananLINKCHECKDIR  = _build/linkcheck
10*4754a72fSPatrick Sanan
11*4754a72fSPatrick Sanan# First so that "make" without arguments is like "make help".
12*4754a72fSPatrick Sananhelp:
13*4754a72fSPatrick Sanan	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
14*4754a72fSPatrick Sanan
15*4754a72fSPatrick Sanan.PHONY: help makefile checklinks
16*4754a72fSPatrick Sanan
17*4754a72fSPatrick Sananchecklinks:
18*4754a72fSPatrick Sanan	@$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(LINKCHECKDIR)" $(SPHINXOPTS)
19*4754a72fSPatrick Sanan	@echo
20*4754a72fSPatrick Sanan	@echo "Check finished. Report is in $(LINKCHECKDIR)."
21*4754a72fSPatrick Sanan
22*4754a72fSPatrick Sananclean-classic-docs:
23*4754a72fSPatrick Sanan	./build_classic_docs.py --clean
24*4754a72fSPatrick Sanan
25*4754a72fSPatrick Sananclean: clean-classic-docs
26*4754a72fSPatrick Sanan
27*4754a72fSPatrick Sananimages:
28*4754a72fSPatrick Sanan	git clone https://gitlab.com/petsc/images.git -b main-1 --depth=1 images
29*4754a72fSPatrick Sanan
30*4754a72fSPatrick Sananwebsite-deploy: images
31*4754a72fSPatrick Sanan	$(SPHINXBUILD) -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) -T -E -j auto
32*4754a72fSPatrick Sanan
33*4754a72fSPatrick Sanan# Catch-all target: route all unknown targets to Sphinx using the new
34*4754a72fSPatrick Sanan# "make mode" option.
35*4754a72fSPatrick Sanan%: makefile images
36*4754a72fSPatrick Sanan	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) -j auto
37*4754a72fSPatrick Sanan
38