mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-11 17:14:41 +00:00
Separate the build step and commit the output to the repository. This way the docs can be built on platforms that do not have inkscape, such as readthedocs. pipenv run make -C doc diagrams pipenv run make -C doc html
25 lines
728 B
Makefile
25 lines
728 B
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS = -W
|
|
SPHINXBUILD = sphinx-build
|
|
SPHINXPROJ = Pybricks
|
|
SOURCEDIR = api
|
|
BUILDDIR = "$(SOURCEDIR)"/build
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
.PHONY: help Makefile
|
|
|
|
diagrams:
|
|
@$(MAKE) -C "$(SOURCEDIR)"/diagram_source clean
|
|
@$(MAKE) -C "$(SOURCEDIR)"/diagram_source
|
|
|
|
# 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)
|