mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-23 07:33:27 -06:00
e9b232fcf4
New Sphinx 5.1.0 (Released: Jul 24, 2022) bumped supported docutils to 0.19: https://github.com/sphinx-doc/sphinx/pull/10656 But m2r2 doesn't support it yet: https://github.com/CrossNox/m2r2/issues/52 Thereby, docutils must be constrained to < 0.19. This should be fixed by m2r2 and after they do it the restriction can be removed. Fixes: https://pagure.io/freeipa/issue/9208 Signed-off-by: Stanislav Levin <slev@altlinux.org> Reviewed-By: Rob Crittenden <rcritten@redhat.com>
40 lines
1.1 KiB
Makefile
40 lines
1.1 KiB
Makefile
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line, and also
|
|
# from the environment for the first two.
|
|
PYTHON ?= python3
|
|
VENVDIR = ./.venv
|
|
SPHINXOPTS ?= -W --keep-going -j auto
|
|
SPHINXBUILD ?= PATH=$(VENVDIR)/bin:$$PATH sphinx-build
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@echo " lint to check and lint documentation"
|
|
@echo " venv to create an isolated venv"
|
|
|
|
.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)
|
|
|
|
.PHONY: lint
|
|
lint:
|
|
$(MAKE) html SPHINXOPTS="$(SPHINXOPTS) -E -a"
|
|
|
|
.PHONY: distclean
|
|
distclean: clean
|
|
rm -rf $(VENVDIR)
|
|
|
|
.PHONY: venv
|
|
venv:
|
|
$(PYTHON) -m venv $(VENVDIR)
|
|
$(VENVDIR)/bin/python3 -m pip install -U pip setuptools
|
|
$(VENVDIR)/bin/python3 -m pip install -U -r ./requirements.txt \
|
|
-c constraints.txt
|