Update doc build makefile
This commit is contained in:
parent
31bc958d86
commit
19586d22e1
3 changed files with 7 additions and 10 deletions
|
|
@ -68,9 +68,7 @@ _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)
|
|
||||||
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:
|
||||||
|
|
@ -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:
|
||||||
|
|
@ -128,7 +123,7 @@ local:
|
||||||
mv-local:
|
mv-local:
|
||||||
make _multiversion-check-env
|
make _multiversion-check-env
|
||||||
make clean
|
make clean
|
||||||
make _multiversion-autodoc-index
|
#make _multiversion-autodoc-index
|
||||||
make _multiversion-build
|
make _multiversion-build
|
||||||
@echo ""
|
@echo ""
|
||||||
@echo "Documentation built (multiversion + autodocs)."
|
@echo "Documentation built (multiversion + autodocs)."
|
||||||
|
|
|
||||||
|
|
@ -187,7 +187,9 @@ if not _no_autodoc:
|
||||||
)
|
)
|
||||||
raise RuntimeError(err)
|
raise RuntimeError(err)
|
||||||
|
|
||||||
print("Evennia root: {}, Game dir: {}".format(EV_ROOT, GAME_DIR))
|
print("Evennia root: {}, Game dir: {}, branch:".format(EV_ROOT, GAME_DIR)),
|
||||||
|
import subprocess
|
||||||
|
subprocess.call(["git", "rev-parse", "--abbrev-ref", "HEAD"])
|
||||||
|
|
||||||
sys.path.insert(1, EV_ROOT)
|
sys.path.insert(1, EV_ROOT)
|
||||||
sys.path.insert(1, GAME_DIR)
|
sys.path.insert(1, GAME_DIR)
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
# Toc
|
# Toc
|
||||||
|
- [API root](api/evennia-api.rst)
|
||||||
- [Coding/Coding Introduction](Coding/Coding-Introduction)
|
- [Coding/Coding Introduction](Coding/Coding-Introduction)
|
||||||
- [Coding/Coding Overview](Coding/Coding-Overview)
|
- [Coding/Coding Overview](Coding/Coding-Overview)
|
||||||
- [Coding/Continuous Integration](Coding/Continuous-Integration)
|
- [Coding/Continuous Integration](Coding/Continuous-Integration)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue