summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorPatrick Rudolph <siro@das-labor.org>2020-05-17 20:04:12 +0200
committerPatrick Georgi <pgeorgi@google.com>2020-07-01 21:51:26 +0000
commitf664321508e1ebfd56f656cbf852997716bbbb3d (patch)
tree0f553602bb2a492f040d10fe55b2f9d7c4a24f58 /Makefile
parentecdbc842e2d48362f27b8652d05606d93d1d7e26 (diff)
downloadcoreboot-f664321508e1ebfd56f656cbf852997716bbbb3d.tar.xz
Documentation: Add several fixes
* Add support for Sphinx 3.0+ * Add backward support for Sphinx 1.8 and older * Make sphinxcontrib ditaa an optional extension * Allow SPHINXOPTS to be set from command line * Add sphinx and sphinx-lint to top level Makefile Change-Id: If10aef51dc426445cb742aad13b19ee7fe169c51 Signed-off-by: Patrick Rudolph <siro@das-labor.org> Reviewed-on: https://review.coreboot.org/c/coreboot/+/41492 Reviewed-by: Patrick Georgi <pgeorgi@google.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile10
1 files changed, 9 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index d60f585a1b..6a96f9dee9 100644
--- a/Makefile
+++ b/Makefile
@@ -83,6 +83,8 @@ help_coreboot help::
@echo ' distclean - Remove build artifacts and config files'
@echo ' doxygen - Build doxygen documentation for coreboot'
@echo ' doxyplatform - Build doxygen documentation for the current platform'
+ @echo ' sphinx - Build sphinx documentation for coreboot'
+ @echo ' sphinx-lint - Build sphinx documenttion for coreboot with warnings as errors'
@echo ' filelist - Show files used in current build'
@echo ' printall - print makefile info for debugging'
@echo ' gitconfig - set up git to submit patches to coreboot'
@@ -419,6 +421,12 @@ cscope-project: clean-cscope $(obj)/project_filelist.txt
cscope:
cscope -bR
+sphinx:
+ $(MAKE) -C Documentation -f Makefile.sphinx html
+
+sphinx-lint:
+ $(MAKE) SPHINXOPTS=-W -C Documentation -f Makefile.sphinx html
+
doxy: doxygen
doxygen:
$(DOXYGEN) Documentation/Doxyfile.coreboot
@@ -465,5 +473,5 @@ distclean: clean clean-ctags clean-cscope distclean-payloads distclean-utils
rm -rf coreboot-builds coreboot-builds-chromeos
rm -f abuild*.xml junit.xml* util/lint/junit.xml
-.PHONY: $(PHONY) clean clean-for-update clean-cscope cscope distclean doxygen doxy doxygen_simple
+.PHONY: $(PHONY) clean clean-for-update clean-cscope cscope distclean doxygen doxy doxygen_simple sphinx sphinx-lint
.PHONY: ctags-project cscope-project clean-ctags