a8cfeb0111
sphinx-build doesn't use the PYTHONPATH from the venv, unless it runs as python3 -m sphinx.cmd.build. We need it to use the imports from PYTHONPATH, so we can update the pyosmocom version in requirements.txt in a patch, and this new version will be used in the jenkins job that runs during gerrit review. Otherwise the previously installed version (from the docker image) will be used. Related: https://github.com/sphinx-doc/sphinx/issues/8910 Change-Id: I487e1af6a3493df5b806cc2d3d2b70bc5233b89f
53 lines
1.6 KiB
Makefile
53 lines
1.6 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.
|
|
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= python3 -m sphinx.cmd.build
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
# for osmo-gsm-manuals
|
|
OSMO_GSM_MANUALS_DIR ?= $(shell pkg-config osmo-gsm-manuals --variable=osmogsmmanualsdir 2>/dev/null)
|
|
OSMO_REPOSITORY = "pysim"
|
|
UPLOAD_FILES = $(BUILDDIR)/latex/osmopysim-usermanual.pdf
|
|
CLEAN_FILES = $(UPLOAD_FILES)
|
|
|
|
# Copy variables from Makefile.common.inc that are used in publish-html,
|
|
# as Makefile.common.inc must be included after publish-html
|
|
PUBLISH_REF ?= master
|
|
PUBLISH_TEMPDIR = _publish_tmpdir
|
|
SSH_COMMAND = ssh -o 'UserKnownHostsFile=$(OSMO_GSM_MANUALS_DIR)/build/known_hosts' -p 48
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
.PHONY: help
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
$(BUILDDIR)/latex/pysim.pdf: latexpdf
|
|
@/bin/true
|
|
|
|
publish-html: html
|
|
rm -rf "$(PUBLISH_TEMPDIR)"
|
|
mkdir -p "$(PUBLISH_TEMPDIR)/pysim/$(PUBLISH_REF)"
|
|
cp -r "$(BUILDDIR)"/html "$(PUBLISH_TEMPDIR)/pysim/$(PUBLISH_REF)"
|
|
cd "$(PUBLISH_TEMPDIR)" && \
|
|
rsync \
|
|
-avzR \
|
|
-e "$(SSH_COMMAND)" \
|
|
"pysim" \
|
|
docs@ftp.osmocom.org:web-files/
|
|
rm -rf "$(PUBLISH_TEMPDIR)"
|
|
|
|
# put this before the catch-all below
|
|
include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
|
|
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%:
|
|
@if [ "$@" != "shrink" ]; then \
|
|
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O); \
|
|
fi
|