Skip to content

Commit 5e1f561

Browse files
committed
(robot_smach_states) first new docs version
1 parent a974f66 commit 5e1f561

File tree

5 files changed

+139
-161
lines changed

5 files changed

+139
-161
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
api
2+
build

Makefile

+7-16
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,19 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
8-
BUILDDIR = _build
8+
BUILDDIR = build
9+
10+
# User-friendly check for sphinx-build
11+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13+
endif
914

1015
# Internal variables.
1116
PAPEROPT_a4 = -D latex_paper_size=a4
1217
PAPEROPT_letter = -D latex_paper_size=letter
1318
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1419
# the i18n builder cannot share the environment and doctrees with the others
15-
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
20+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
1621

1722
.PHONY: help
1823
help:
@@ -27,7 +32,6 @@ help:
2732
@echo " applehelp to make an Apple Help Book"
2833
@echo " devhelp to make HTML files and a Devhelp project"
2934
@echo " epub to make an epub"
30-
@echo " epub3 to make an epub3"
3135
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
3236
@echo " latexpdf to make LaTeX files and run them through pdflatex"
3337
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@@ -42,7 +46,6 @@ help:
4246
@echo " linkcheck to check all external links for integrity"
4347
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
4448
@echo " coverage to run coverage check of the documentation (if enabled)"
45-
@echo " dummy to check syntax errors of document sources"
4649

4750
.PHONY: clean
4851
clean:
@@ -120,12 +123,6 @@ epub:
120123
@echo
121124
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
122125

123-
.PHONY: epub3
124-
epub3:
125-
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
126-
@echo
127-
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
128-
129126
.PHONY: latex
130127
latex:
131128
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@@ -217,9 +214,3 @@ pseudoxml:
217214
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
218215
@echo
219216
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
220-
221-
.PHONY: dummy
222-
dummy:
223-
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
224-
@echo
225-
@echo "Build finished. Dummy builder generates no files."

0 commit comments

Comments
 (0)