2023-11-26 20:37:34 -07:00
|
|
|
|
2023-11-26 15:54:31 -07:00
|
|
|
# Makefile
|
|
|
|
# Jeff Moe with Parrot and Phind-CodeLlama-34B-v2_q8.gguf
|
|
|
|
|
2023-11-26 16:26:31 -07:00
|
|
|
SPHINXOPTS ?=
|
|
|
|
SPHINXBUILD ?= sphinx-build
|
|
|
|
SOURCEDIR = docs/source
|
|
|
|
BUILDDIR = docs/build
|
|
|
|
AUTOBUILDOPTS = --host 127.0.0.1 --port 8000 --ignore "*.swp" --ignore "*.swx"
|
2023-11-26 20:29:32 -07:00
|
|
|
GETTEXT_BUILD = gettext_build
|
2023-11-26 23:02:28 -07:00
|
|
|
UPDATE_LOCALE_EN = sphinx-intl update -p $(BUILDDIR)/locale/gettext -d $(SOURCEDIR)/locale -l en
|
|
|
|
UPDATE_LOCALE_ES = sphinx-intl update -p $(BUILDDIR)/locale/gettext -d $(SOURCEDIR)/locale -l es
|
2023-11-26 16:26:31 -07:00
|
|
|
|
2023-11-27 09:10:33 -07:00
|
|
|
.PHONY: help html livehtml clean_sphinx clean gettext_build update_locale_en update_locale_es build_html_en build_html_es all copy
|
|
|
|
|
|
|
|
help:
|
|
|
|
@echo "Please use \`make <target>' where <target> is one of"
|
|
|
|
@echo " html to make standalone HTML files"
|
|
|
|
@echo " livehtml to serve the documentation with live reloading"
|
|
|
|
@echo " clean_sphinx to remove all built files in docs/"
|
|
|
|
@echo " clean to remove all build files and directories (including translations)"
|
|
|
|
@echo " gettext_build to build localisation strings for translation"
|
|
|
|
@echo " update_locale_en to update English localisation"
|
|
|
|
@echo " update_locale_es to update Spanish localisation"
|
|
|
|
@echo " build_html_en to build the HTML documentation for English"
|
|
|
|
@echo " build_html_es to build the HTML documentation for Spanish"
|
|
|
|
@echo " all to clean and make all targets"
|
|
|
|
@echo " copy to copy docs/index.html to docs/build/html/index.html"
|
2023-11-26 20:37:34 -07:00
|
|
|
|
2023-11-26 23:22:19 -07:00
|
|
|
all: clean_sphinx build_html_en build_html_es gettext_build update_locale_en update_locale_es copy
|
|
|
|
|
|
|
|
copy:
|
|
|
|
cp docs/index.html docs/build/html/index.html
|
2023-11-26 16:19:12 -07:00
|
|
|
|
2023-11-26 15:54:31 -07:00
|
|
|
html:
|
2023-11-26 16:26:31 -07:00
|
|
|
cd docs && make $(SPHINXOPTS) html
|
|
|
|
|
|
|
|
livehtml:
|
|
|
|
sphinx-autobuild $(AUTOBUILDOPTS) $(SOURCEDIR) $(BUILDDIR)/html
|
2023-11-26 16:19:12 -07:00
|
|
|
|
|
|
|
clean_sphinx:
|
2023-11-26 16:26:31 -07:00
|
|
|
cd docs && make clean
|
2023-11-26 16:19:12 -07:00
|
|
|
|
2023-11-26 20:35:28 -07:00
|
|
|
clean: clean_sphinx
|
2023-11-26 16:26:31 -07:00
|
|
|
rm -rf $(BUILDDIR)/*
|
2023-11-26 20:29:32 -07:00
|
|
|
|
|
|
|
gettext_build:
|
|
|
|
$(SPHINXBUILD) -b gettext -c $(SOURCEDIR) -d $(BUILDDIR)/doctrees/$(GETTEXT_BUILD) $(SOURCEDIR) $(BUILDDIR)/locale/gettext
|
2023-11-26 20:33:43 -07:00
|
|
|
|
|
|
|
update_locale_en:
|
|
|
|
$(UPDATE_LOCALE_EN)
|
|
|
|
|
|
|
|
update_locale_es:
|
|
|
|
$(UPDATE_LOCALE_ES)
|
|
|
|
|
|
|
|
build_html_en:
|
|
|
|
$(SPHINXBUILD) -b html -d $(BUILDDIR)/doctrees -D language=en $(SOURCEDIR) $(BUILDDIR)/html/en
|
|
|
|
|
|
|
|
build_html_es:
|
|
|
|
$(SPHINXBUILD) -b html -d $(BUILDDIR)/doctrees -D language=es $(SOURCEDIR) $(BUILDDIR)/html/es
|
2023-11-27 09:31:09 -07:00
|
|
|
|