annotate doc/Makefile @ 60:682cd33e564c draft

Documentation (incomplete).
author David Barts <n5jrn@me.com>
date Sat, 08 Jun 2019 07:43:15 -0700
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
60
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
1 # Minimal makefile for Sphinx documentation
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
2 #
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
3
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
4 # You can set these variables from the command line, and also
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
5 # from the environment for the first two.
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
6 SPHINXOPTS ?=
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
7 SPHINXBUILD ?= sphinx-build
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
8 SOURCEDIR = .
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
9 BUILDDIR = _build
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
10
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
11 # Put it first so that "make" without argument is like "make help".
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
12 help:
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
13 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
14
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
15 .PHONY: help Makefile
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
16
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
17 # Catch-all target: route all unknown targets to Sphinx using the new
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
18 # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
19 %: Makefile
682cd33e564c Documentation (incomplete).
David Barts <n5jrn@me.com>
parents:
diff changeset
20 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)