annotate doc/Makefile @ 405:c56a728412f1

file organisation + setup refactoring: - `/src` has been renamed to `/sat_pubsub`, this is the recommended naming convention - revamped `setup.py` on the basis of SàT's `setup.py` - added a `VERSION` which is the unique place where version number will now be set - use same trick as in SàT to specify dev version (`D` at the end) - use setuptools_scm to retrieve Mercurial hash when in dev version
author Goffi <goffi@goffi.org>
date Fri, 16 Aug 2019 12:00:02 +0200
parents 105a0772eedd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 # Minimal makefile for Sphinx documentation
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 #
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # You can set these variables from the command line.
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
5 SPHINXOPTS =
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
7 SOURCEDIR = .
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
8 BUILDDIR = .build
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
9
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # Put it first so that "make" without argument is like "make help".
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11 help:
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14 .PHONY: help Makefile
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16 # Catch-all target: route all unknown targets to Sphinx using the new
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18 %: Makefile
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)