1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# Copyright 2015-2021 Nir Cohen
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Name of this package
PACKAGENAME = distro
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?= -n -v
SPHINXBUILD ?= sphinx-build
SPHINXSOURCEDIR = docs
SPHINXBUILDDIR = docs/_build
.PHONY: help
help:
@echo 'Please use "make <target>" where <target> is one of'
@echo " release - build a release and publish it"
@echo " dev - prepare a development environment (includes tests)"
@echo " instdev - prepare a development environment (no tests)"
@echo " install - install into current Python environment"
@echo " clobber - remove any build products"
@echo " build - build the package"
@echo " test - test from this directory using tox, including test coverage"
@echo " publish - upload to PyPI"
@echo " clean - remove any temporary build products"
@echo " dry-run - perform all action required for a release without actually releasing"
@$(SPHINXBUILD) -M help "$(SPHINXSOURCEDIR)" "$(SPHINXBUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: release
release: test clean build publish
@echo "$@ done."
.PHONY: test
test:
pip install 'tox>=1.9.0'
tox
@echo "$@ done."
.PHONY: clean
clean:
rm -rf dist build $(PACKAGENAME).egg-info
@echo "$@ done."
.PHONY: build
build:
python -m build
.PHONY: publish
publish:
twine upload -r pypi dist/$(PACKAGENAME)-*
@echo "$@ done."
.PHONY: dry-run
dry-run: test clean build
@echo "$@ done."
.PHONY: dev
dev: instdev test
@echo "$@ done."
.PHONY: instdev
instdev:
pip install -r dev-requirements.txt
pip install -e .
@echo "$@ done."
.PHONY: install
install:
pip install .
@echo "$@ done."
.PHONY: clobber
clobber: clean
rm -rf $(SPHINXBUILDDIR)
@echo "$@ done."
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
.PHONY: Makefile
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SPHINXSOURCEDIR)" "$(SPHINXBUILDDIR)" $(SPHINXOPTS) $(O)
|
