mirror of
https://codeberg.org/openpgp/notes.git
synced 2024-11-23 08:02:05 +01:00
37 lines
1.2 KiB
Makefile
37 lines
1.2 KiB
Makefile
# SPDX-FileCopyrightText: 2023 The "Notes on OpenPGP" project
|
|
# SPDX-License-Identifier: CC0-1.0
|
|
#
|
|
# Minimal makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line, and also
|
|
# from the environment for the first two.
|
|
CODESPELL ?= codespell
|
|
SPHINXOPTS ?= -W
|
|
SPHINXBUILD ?= sphinx-build
|
|
LYCHEE ?= lychee
|
|
PRINTF ?= printf
|
|
SOURCEDIR = source
|
|
BUILDDIR = build
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
html-linkcheck: clean html
|
|
@$(LYCHEE) "$(BUILDDIR)/html/"*.html
|
|
|
|
# spell check all sources
|
|
# NOTE: diagrams are not yet spell checked, but we emit the required changes
|
|
codespell:
|
|
@$(PRINTF) "The following change suggestions are only warnings! (Please don't fix them)\n"
|
|
@$(CODESPELL) source/diag || true
|
|
@$(PRINTF) "The following change suggestions are errors!\n"
|
|
@$(CODESPELL) .
|
|
|
|
.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)
|