You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
39 lines
1.0 KiB
39 lines
1.0 KiB
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line, and also
|
|
# from the environment for the first two.
|
|
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= sphinx-build
|
|
SOURCEDIR = .
|
|
BUILDDIR = ../out/docs
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
.PHONY: help Makefile clean examples
|
|
|
|
clean:
|
|
rm -rf doxyoutput/ api/
|
|
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
copy-plugin-readmes:
|
|
install -d plugins
|
|
(cd ../plugins; \
|
|
ls -d * |xargs -n 1 -I % cp %/README.md ../docs/plugins/%.md )
|
|
|
|
|
|
examples:
|
|
install -d examples
|
|
(cd ../examples; \
|
|
find . -type f \( -name \*ino -or -name \*h -or -name \*cpp \) \
|
|
) | \
|
|
xargs -n 1 -I % ../bin/docs/example-to-doc %
|
|
|
|
# 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)
|
|
|