From 74f5a609f6539b47adf5db754fba795f1163aeb9 Mon Sep 17 00:00:00 2001 From: Griatch Date: Mon, 12 Oct 2020 22:19:22 +0200 Subject: [PATCH] Sync doc makefile with master --- docs/Makefile | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index ec38926c91..07719aa176 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -56,7 +56,7 @@ _multiversion-check-env: _clean_api_index: rm source/api/* -# remove superfluous 'module' and 'package' text from api headers +# remove superfluos 'module' and 'package' text from api headers _reformat_apidoc_headers: for f in source/api/*.rst; do\ perl -pi -e 's/(module|package)$$// if $$. == 1' $$f ;\ @@ -71,7 +71,7 @@ _multiversion-autodoc-index: make _clean_api_index @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE) make _reformat_apidoc_headers - -git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index." + git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index." _html-build: @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" @@ -84,7 +84,7 @@ _multiversion-build: _multiversion-deploy: @bash -e deploy.sh - @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXMULTIVERSION) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" + @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXMULTIVERSION) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) _latex-build: @NOAUTODOC=1 EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)/latex" $(QUICKFILES) @@ -96,7 +96,7 @@ install: clean: @rm -Rf $(BUILDDIR) - # @git clean -f -d docs/ + @git clean -f -d docs/ @echo "Cleaned old build dir and leftover files." # not fully working at this time @@ -107,12 +107,15 @@ pdf: @echo "To see result, open evennia/docs/build/latex/evennia.pdf in a PDF reader." quick: - make _check-env make _quick-html-build $(FILES) @echo "" @echo "Documentation built (single version, no autodocs)." @echo "To see result, open evennia/docs/build/html/index.html in a browser." +# abort on warnings too +quickstrict: + SPHINXOPTS=-W make quick + local: make _check-env make clean