1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
# -*- mode: gnumakefile; tab-width: 4; indent-tabs-mode: t; -*-
# vim: tabstop=4
define HELP_TEXT
Custom Targets
==============
Convenience targets provided for building docs.
- html (default) to build HTML documentation.
- livehtml to auto build HTML on file changes on host on localhost.
- epubpdf to convert an epub file to PDF.
Translations
------------
- update_po to update PO message catalogs.
- report_po_progress to check the progress/fuzzy strings.
Checking
--------
- check_structure to check the structure of all .rst files.
- check_syntax to check the syntax of all .rst files.
- check_spelling to check spelling for text in RST files.
Utilities
---------
- update to update the repository to the most recent version.
- format_py to auto-format Python scripts.
Environment Variables
---------------------
- NO_INTERSPHINX
When non-zero & non-empty any build-targets that run sphinx will not use
'intersphinx' (which requires online access).
endef
# HELP_TEXT (end)
# -----------
# System Vars
OS:=$(shell uname -s)
# End System Vars
# ---------------
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXBUILD ?= sphinx-build
SPHINXAUTOBUILD ?= sphinx-autobuild
SOURCEDIR = ./manual
BUILDDIR ?= build
BF_LANG ?= en
SPHINXOPTS ?= -j auto -D language='$(BF_LANG)'
LATEXOPTS ?= "-interaction nonstopmode"
# -----------------------
# for echoing output only
ifeq ($(OS), Darwin)
OPEN_CMD="open" # MACOS.
else
OPEN_CMD="xdg-open" # Linux/FreeBSD.
endif
# end output for echoing
# ----------------------
ifneq ("$(shell which $(SPHINXAUTOBUILD) 2> /dev/null)", "")
.DEFAULT_GOAL := livehtml
else
.DEFAULT_GOAL := html
endif
# --------------------
# Check commands exist
.SPHINXBUILD_EXISTS:
@if ! which $(SPHINXBUILD) > /dev/null 2>&1; then \
echo -e >&2 \
"The '$(SPHINXBUILD)' command was not found.\n"\
"Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to\n"\
"point to the full path of the '$(SPHINXBUILD)' executable.\n"\
"Alternatively you can add the directory with the executable to your PATH.\n"\
"If you don't have Sphinx installed, grab it from http://sphinx-doc.org)\n"; \
false; \
fi
# End command checking
# --------------------
html: .SPHINXBUILD_EXISTS
$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo "To view, run:"
@echo " "$(OPEN_CMD) $(shell pwd)"/$(BUILDDIR)/html/index.html"
livehtml:
@$(SPHINXAUTOBUILD) --open-browser --delay 0 "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
epubpdf: .SPHINXBUILD_EXISTS
@$(SPHINXBUILD) -M epub "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@ebook-convert $(BUILDDIR)/epub/*.epub blender_manual.pdf \
--pdf-default-font-size 16 \
--pdf-mono-font-size 14 \
--margin-left 0 \
--margin-right 0 \
--pdf-page-margin-left 50 \
--pdf-page-margin-right 50 \
--pdf-page-margin-top 50 \
--pdf-page-margin-bottom 50 \
check_syntax:
@python3 tools/check_source/check_syntax.py --long --title --kbd > rst_check_syntax.log
@echo "Lines:" `cat rst_check_syntax.log | wc -l`
@python3 tools/utils_ide/open_quickfix_in_editor.py rst_check_syntax.log
@rm rst_check_syntax.log
check_structure:
@python3 tools/check_source/check_images.py
@python3 tools/check_source/check_structure.py
check_spelling:
@python3 tools/check_source/check_spelling.py
checkout_locale:
@python3 ./build_files/utils/checkout_locale.py
update_po:
@python3 ./tools/translations/update_po.py
report_po_progress:
@python3 tools/translations/report_translation_progress.py --quiet \
`find locale/ -maxdepth 1 -mindepth 1 -type d -not -iwholename '*.git*' -printf 'locale/%f\n' | sort`
update:
@python3 ./build_files/utils/make_update.py
format_py:
@autopep8 --in-place --recursive .
# ----------------------
# Help for build targets
export HELP_TEXT
help:
@echo ""
@echo "Sphinx"
@echo "======"
@echo ""
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@echo ""
@echo "$$HELP_TEXT"
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile .SPHINXBUILD_EXISTS
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
