mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
doc-building tests
This commit is contained in:
parent
e8e4bcbcad
commit
76d087ffb0
3 changed files with 11 additions and 3 deletions
|
|
@ -78,7 +78,7 @@ _quick-html-build:
|
|||
@NOAUTODOC=1 EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" $(QUICKFILES)
|
||||
|
||||
_multiversion-build:
|
||||
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXMULTIVERSION) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)
|
||||
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXMULTIVERSION) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) -v
|
||||
|
||||
_multiversion-deploy:
|
||||
@bash -e deploy.sh
|
||||
|
|
@ -111,6 +111,7 @@ quick:
|
|||
quickstrict:
|
||||
SPHINXOPTS=-W make quick
|
||||
|
||||
# we build index directly for the current branch
|
||||
local:
|
||||
make _check-env
|
||||
make clean
|
||||
|
|
@ -120,10 +121,14 @@ local:
|
|||
@echo "Documentation built (single version)."
|
||||
@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:
|
||||
make _multiversion-check-env
|
||||
make clean
|
||||
#make _multiversion-autodoc-index
|
||||
make _multiversion-build
|
||||
@echo ""
|
||||
@echo "Documentation built (multiversion + autodocs)."
|
||||
|
|
|
|||
|
|
@ -176,7 +176,7 @@ ansi_clean = None
|
|||
if not _no_autodoc:
|
||||
# we must set up Evennia and its paths for autodocs to work
|
||||
|
||||
EV_ROOT = os.environ.get("EVDIR")
|
||||
EV_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) # os.environ.get("EVDIR")
|
||||
GAME_DIR = os.environ.get("EVGAMEDIR")
|
||||
|
||||
if not (EV_ROOT and GAME_DIR):
|
||||
|
|
@ -190,6 +190,7 @@ if not _no_autodoc:
|
|||
print("Evennia root: {}, Game dir: {}, branch:".format(EV_ROOT, GAME_DIR)),
|
||||
import subprocess
|
||||
subprocess.call(["git", "rev-parse", "--abbrev-ref", "HEAD"])
|
||||
subprocess.call("pwd")
|
||||
|
||||
sys.path.insert(1, EV_ROOT)
|
||||
sys.path.insert(1, GAME_DIR)
|
||||
|
|
|
|||
|
|
@ -4,6 +4,8 @@ This module defines the basic `DefaultObject` and its children
|
|||
These are the (default) starting points for all in-game visible
|
||||
entities.
|
||||
|
||||
This is the v1.0 develop version (for ref in doc building).
|
||||
|
||||
"""
|
||||
import time
|
||||
import inflect
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue