Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Sync doc makefile with master

Browse source
This commit is contained in:
Griatch 2020-10-12 22:19:22 +02:00
parent b449ebe3d4
commit 74f5a609f6
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/Makefile
View file

@ -56,7 +56,7 @@ _multiversion-check-env:
_clean_api_index: _clean_api_index:
rm source/api/* rm source/api/*
# remove superfluous 'module' and 'package' text from api headers # remove superfluos 'module' and 'package' text from api headers
_reformat_apidoc_headers: _reformat_apidoc_headers:
for f in source/api/*.rst; do\ for f in source/api/*.rst; do\
perl -pi -e 's/(module|package)$$// if $$. == 1' $$f ;\ perl -pi -e 's/(module|package)$$// if $$. == 1' $$f ;\
@ -71,7 +71,7 @@ _multiversion-autodoc-index:
make _clean_api_index make _clean_api_index
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE) @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE)
make _reformat_apidoc_headers 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: _html-build:
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" @EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html"
@ -84,7 +84,7 @@ _multiversion-build:
_multiversion-deploy: _multiversion-deploy:
@bash -e deploy.sh @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: _latex-build:
@NOAUTODOC=1 EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)/latex" $(QUICKFILES) @NOAUTODOC=1 EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)/latex" $(QUICKFILES)
@ -96,7 +96,7 @@ install:
clean: clean:
@rm -Rf $(BUILDDIR) @rm -Rf $(BUILDDIR)
# @git clean -f -d docs/ @git clean -f -d docs/
@echo "Cleaned old build dir and leftover files." @echo "Cleaned old build dir and leftover files."
# not fully working at this time # 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." @echo "To see result, open evennia/docs/build/latex/evennia.pdf in a PDF reader."
quick: quick:
make _check-env
make _quick-html-build $(FILES) make _quick-html-build $(FILES)
@echo "" @echo ""
@echo "Documentation built (single version, no autodocs)." @echo "Documentation built (single version, no autodocs)."
@echo "To see result, open evennia/docs/build/html/index.html in a browser." @echo "To see result, open evennia/docs/build/html/index.html in a browser."
# abort on warnings too
quickstrict:
SPHINXOPTS=-W make quick
local: local:
make _check-env make _check-env
make clean make clean