934beb6e20
Related issue scylladb/sphinx-scylladb-theme#395 ScyllaDB Sphinx Theme 1.2 is now released partying_face We’ve added automatic checks for broken links and introduced numerous UI updates. You can read more about all notable changes here. Closes #10313
95 lines
2.3 KiB
Makefile
95 lines
2.3 KiB
Makefile
# You can set these variables from the command line.
|
|
POETRY := poetry
|
|
SPHINXBUILD := $(POETRY) run sphinx-build
|
|
SPHINXOPTS :=
|
|
PAPER :=
|
|
BUILDDIR := _build
|
|
SOURCEDIR := .
|
|
|
|
# Internal variables.
|
|
PAPEROPT_a4 := -D latex_paper_size=a4
|
|
PAPEROPT_letter := -D latex_paper_size=letter
|
|
ALLSPHINXOPTS := -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
|
|
TESTSPHINXOPTS := $(ALLSPHINXOPTS) -W --keep-going
|
|
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
|
I18NSPHINXOPTS := $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCEDIR)
|
|
|
|
# Windows variables
|
|
ifeq ($(OS),Windows_NT)
|
|
POETRY = $(APPDATA)\Python\Scripts\poetry
|
|
endif
|
|
|
|
.PHONY: all
|
|
all: dirhtml
|
|
|
|
# Setup commands
|
|
.PHONY: setupenv
|
|
setupenv:
|
|
pip install -q poetry
|
|
|
|
.PHONY: setup
|
|
setup:
|
|
$(POETRY) install
|
|
$(POETRY) update
|
|
|
|
# Clean commands
|
|
.PHONY: pristine
|
|
pristine: clean
|
|
git clean -dfX
|
|
|
|
.PHONY: clean
|
|
clean:
|
|
rm -rf $(BUILDDIR)/*
|
|
|
|
# Generate output commands
|
|
.PHONY: dirhtml
|
|
dirhtml: setup
|
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
|
|
.PHONY: singlehtml
|
|
singlehtml: setup
|
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
@echo
|
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
|
|
.PHONY: epub
|
|
epub: setup
|
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
@echo
|
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
|
|
.PHONY: epub3
|
|
epub3: setup
|
|
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
|
|
@echo
|
|
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
|
|
|
|
.PHONY: multiversion
|
|
multiversion: setup
|
|
$(POETRY) run sphinx-multiversion $(SOURCEDIR) $(BUILDDIR)/dirhtml
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
|
|
# Preview commands
|
|
.PHONY: preview
|
|
preview: setup
|
|
$(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500
|
|
|
|
.PHONY: multiversionpreview
|
|
multiversionpreview: multiversion
|
|
$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
|
|
|
|
# Test commands
|
|
.PHONY: test
|
|
test: setup
|
|
$(SPHINXBUILD) -b dirhtml $(TESTSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
|
|
.PHONY: linkcheck
|
|
linkcheck: setup
|
|
$(SPHINXBUILD) -b linkcheck $(SOURCEDIR) $(BUILDDIR)/linkcheck
|