mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
c03229cd9d
This also updates the index page, changes the first
sidebar section to be "About" without an extra level,
and renames "Tutorials" to "Manual"
(cherry picked from commit 0c100d9f14)
38 lines
1.3 KiB
Makefile
38 lines
1.3 KiB
Makefile
# Makefile for Sphinx documentation
|
|
|
|
SPHINXOPTS ?=
|
|
SPHINXBUILD ?= sphinx-build
|
|
SPHINXSOURCEDIR ?= .
|
|
SPHINXBUILDDIR ?= _build
|
|
SPHINXPAPER ?=
|
|
FILELIST ?=
|
|
|
|
# User-friendly check for sphinx-build
|
|
ifneq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 0)
|
|
define ERROR_MESSAGE
|
|
The '$(SPHINXBUILD)' command was not found!
|
|
Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to the full path of the '$(SPHINXBUILD)' executable.
|
|
Alternatively you can add the executable's directory to your PATH.
|
|
If you don't have Sphinx installed, grab it from http://sphinx-doc.org/
|
|
endef
|
|
$(error ${ERROR_MESSAGE})
|
|
endif
|
|
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
COMMONSPHINXOPTS = $(PAPEROPT_$(SPHINXPAPER)) $(SPHINXOPTS) '$(SPHINXSOURCEDIR)'
|
|
DEFAULTSPHINXOPTS = -d $(SPHINXBUILDDIR)/doctrees $(COMMONSPHINXOPTS)
|
|
|
|
.PHONY: help clean
|
|
|
|
help:
|
|
@$(SPHINXBUILD) -M help $(DEFAULTSPHINXOPTS) $(O) "$(SPHINXBUILDDIR)"
|
|
|
|
# This is used by https://github.com/godotengine/godot-docs-l10n
|
|
# See https://github.com/godotengine/godot-docs-l10n/blob/f157c0cacc8a6e542e06e96b983b27de91637f8b/update.sh#L92
|
|
gettext:
|
|
$(SPHINXBUILD) -b gettext -t i18n $(COMMONSPHINXOPTS) ../sphinx/templates $(FILELIST)
|
|
|
|
%:
|
|
$(SPHINXBUILD) -M $@ $(DEFAULTSPHINXOPTS) $(O) "$(SPHINXBUILDDIR)"/$@ $(FILELIST)
|