2023-05-18 14:49:44 +00:00
# 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 = _build
# Put it first so that "make" without argument is like "make help".
help :
2023-05-21 23:25:52 +00:00
@$( SPHINXBUILD) -M help " $( SOURCEDIR) " " $( BUILDDIR) " $( SPHINXOPTS) $( O) && echo " \033[0;34mlint\033[0m runs markdownlint on all markdown files (this was added to the Makefile manually. pardon formatting)"
2023-05-18 14:49:44 +00:00
2023-05-20 19:33:00 +00:00
lint :
2023-09-16 00:29:02 +00:00
( markdownlint -V > /dev/null || npm install -g markdownlint-cli) && markdownlint **/*.md
2023-05-20 19:33:00 +00:00
2023-05-18 14:49:44 +00:00
.PHONY : help Makefile
# 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)