mirror of
https://github.com/ZGCA-Forge/MsgCenterPy.git
synced 2025-12-14 13:04:34 +00:00
65 lines
2.1 KiB
Makefile
65 lines
2.1 KiB
Makefile
# Makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line, and also
|
|
# from the environment for the first two.
|
|
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= 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)
|
|
|
|
.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)
|
|
|
|
# Custom targets for common operations
|
|
clean:
|
|
@echo "Cleaning build directory..."
|
|
rm -rf $(BUILDDIR)/*
|
|
|
|
html:
|
|
@echo "Building HTML documentation..."
|
|
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
|
|
livehtml:
|
|
@echo "Starting live HTML build..."
|
|
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
|
|
|
|
linkcheck:
|
|
@echo "Checking external links..."
|
|
@$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)/linkcheck" $(SPHINXOPTS) $(O)
|
|
@echo
|
|
@echo "Link check complete; look for any errors in the above output."
|
|
|
|
doctest:
|
|
@echo "Running doctests..."
|
|
@$(SPHINXBUILD) -b doctest "$(SOURCEDIR)" "$(BUILDDIR)/doctest" $(SPHINXOPTS) $(O)
|
|
@echo "doctest finished; look at the results in $(BUILDDIR)/doctest."
|
|
|
|
coverage:
|
|
@echo "Checking documentation coverage..."
|
|
@$(SPHINXBUILD) -b coverage "$(SOURCEDIR)" "$(BUILDDIR)/coverage" $(SPHINXOPTS) $(O)
|
|
@echo "Coverage finished; see $(BUILDDIR)/coverage/python.txt."
|
|
|
|
latexpdf:
|
|
@echo "Building LaTeX files and running them through pdflatex..."
|
|
@$(SPHINXBUILD) -b latex "$(SOURCEDIR)" "$(BUILDDIR)/latex" $(SPHINXOPTS) $(O)
|
|
@echo "Running LaTeX files through pdflatex..."
|
|
@make -C $(BUILDDIR)/latex all-pdf
|
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
|
|
epub:
|
|
@echo "Building EPUB documentation..."
|
|
@$(SPHINXBUILD) -b epub "$(SOURCEDIR)" "$(BUILDDIR)/epub" $(SPHINXOPTS) $(O)
|
|
@echo
|
|
@echo "Build finished. The EPUB file is in $(BUILDDIR)/epub."
|