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

Changes to docs setup

Browse source
This commit is contained in:
Griatch 2020-04-05 13:00:01 +02:00
parent d5b91a1bf3
commit c1dafcb3fa
3 changed files with 66 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

52
docs/Makefile
View file

@ -7,6 +7,7 @@ SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
AUTODOCDIR = $(SOURCEDIR)/api
EVDIR ?= $(realpath ../evennia)
EVGAMEDIR ?= $(realpath ../../gamedir)
@ -23,48 +24,51 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
make help
# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
# Evennia - custom commands
install:
@pip install -r requirements.txt
check-env:
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) bash -e checkenv.sh
# build only the api-autodoc index
# build / update only the api-autodoc index
autodoc-index:
@sphinx-apidoc -f -o $(SOURCEDIR)/api/ $(EVDIR)
api-build:
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) $(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)/html/api"
clean:
@rm -Rf $(BUILDDIR)
@git clean -f -d docs/
@echo "Cleaned old build dir and leftover files."
# multiversion release builds
mv-check-env:
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) bash -e checkenv.sh multiversion
# we must commit the index before it's made available to multiversion
mv-autodoc-index:
@sphinx-apidoc -f -o $(SOURCEDIR)/api/ $(EVDIR)
git commit -a -m "Updated API autodoc index."
multiversion-build:
@EVDIR=$(EVDIR) EVGAMEDIR=$(EVGAMEDIR) sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)/html"
clean:
@rm -Rf $(BUILDDIR)
@git clean -f -d
@echo "Cleaned old build dir and leftover files."
local:
make check-env
make clean
make autodoc-index
make multiversion-build
deploy:
mv-deploy:
@bash -e deploy.sh
# build and prepare the docs for release
release:
make check-env
mv-local:
make mv-check-env
make clean
make autodoc-index
make mv-autodoc-index
make multiversion-build
make deploy
make clean
# build and prepare the docs for release
mv-release:
make mv-local
# make mv-deploy
@echo ""
@echo "Deployment complete."