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

Update makefile from develop

Browse source
This commit is contained in:
Griatch 2021-02-24 23:25:46 +01:00
parent af88ccfd61
commit e6f0439d31
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/Makefile
View file

@ -10,7 +10,7 @@ SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build SPHINXBUILD ?= sphinx-build
SPHINXMULTIVERSION ?= sphinx-multiversion SPHINXMULTIVERSION ?= sphinx-multiversion
SPHINXAPIDOC ?= sphinx-apidoc SPHINXAPIDOC ?= sphinx-apidoc
SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force --maxdepth 6 --separate --templatedir=$(SOURCEDIR)/_templates/ SPHINXAPIDOCOPTS = --tocfile evennia-api --module-first --force -d 6 --separate --templatedir=$(SOURCEDIR)/_templates/
SPHINXAPIDOCENV = members,undoc-members,show-inheritance SPHINXAPIDOCENV = members,undoc-members,show-inheritance
SPHINXAPIDOCEXCLUDE = ../*/migrations/* ../evennia/game_template/* ../evennia/*/tests/* ../evennia/*/tests.py SPHINXAPIDOCEXCLUDE = ../*/migrations/* ../evennia/game_template/* ../evennia/*/tests/* ../evennia/*/tests.py
@ -68,10 +68,8 @@ _autodoc-index:
make _reformat_apidoc_headers make _reformat_apidoc_headers
_multiversion-autodoc-index: _multiversion-autodoc-index:
make _clean_api_index make _autodoc-index
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) SPHINX_APIDOC_OPTIONS=$(SPHINXAPIDOCENV) $(SPHINXAPIDOC) $(SPHINXAPIDOCOPTS) -o $(SOURCEDIR)/api/ $(EVDIR) $(SPHINXAPIDOCEXCLUDE) git diff-index --quiet HEAD || git commit -a -m "Updated API autodoc index." || :
make _reformat_apidoc_headers
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,14 +82,11 @@ _multiversion-build:
_multiversion-deploy: _multiversion-deploy:
@bash -e deploy.sh @bash -e deploy.sh
@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)
# main targets # main target:
install:
@pip install -r requirements.txt @pip install -r requirements.txt
clean: clean:
@ -116,6 +111,7 @@ quick:
quickstrict: quickstrict:
SPHINXOPTS=-W make quick SPHINXOPTS=-W make quick
# we build index directly for the current branch
local: local:
make _check-env make _check-env
make clean make clean
@ -125,10 +121,14 @@ local:
@echo "Documentation built (single version)." @echo "Documentation built (single version)."
@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."
# note that this should be done for each relevant multiversion branch.
mv-index:
make _multiversion-autodoc-index
@echo "(Re)Built and committed api rst files for this branch only."
mv-local: mv-local:
make _multiversion-check-env make _multiversion-check-env
make clean make clean
make _multiversion-autodoc-index
make _multiversion-build make _multiversion-build
@echo "" @echo ""
@echo "Documentation built (multiversion + autodocs)." @echo "Documentation built (multiversion + autodocs)."