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

doc-building tests

Browse source
This commit is contained in:
Griatch 2021-02-24 19:27:55 +01:00
parent e8e4bcbcad
commit 76d087ffb0
3 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/Makefile
View file

@ -78,7 +78,7 @@ _quick-html-build:
@NOAUTODOC=1 EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" $(QUICKFILES) @NOAUTODOC=1 EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html" $(QUICKFILES)
_multiversion-build: _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: _multiversion-deploy:
@bash -e deploy.sh @bash -e deploy.sh
@ -111,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
@ -120,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)."

3
docs/source/conf.py
View file

@ -176,7 +176,7 @@ ansi_clean = None
if not _no_autodoc: if not _no_autodoc:
# we must set up Evennia and its paths for autodocs to work # 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") GAME_DIR = os.environ.get("EVGAMEDIR")
if not (EV_ROOT and GAME_DIR): 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)), print("Evennia root: {}, Game dir: {}, branch:".format(EV_ROOT, GAME_DIR)),
import subprocess import subprocess
subprocess.call(["git", "rev-parse", "--abbrev-ref", "HEAD"]) subprocess.call(["git", "rev-parse", "--abbrev-ref", "HEAD"])
subprocess.call("pwd")
sys.path.insert(1, EV_ROOT) sys.path.insert(1, EV_ROOT)
sys.path.insert(1, GAME_DIR) sys.path.insert(1, GAME_DIR)

2
evennia/objects/objects.py
View file

@ -4,6 +4,8 @@ This module defines the basic `DefaultObject` and its children
These are the (default) starting points for all in-game visible These are the (default) starting points for all in-game visible
entities. entities.
This is the v1.0 develop version (for ref in doc building).
""" """
import time import time
import inflect import inflect