Skip to content

Commit fc32ff3

Browse files
committed
Build docs locally without worry about configuring each time
1 parent 3fe2633 commit fc32ff3

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/Makefile

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ SPHINXBUILD = sphinx-build
77
SOURCEDIR = .
88
BUILDDIR = _build
99

10+
# sphinx-hoverxref expected variables
11+
export READTHEDOCS=True
12+
export READTHEDOCS_PROJECT=sphinx-hoverxref
13+
export READTHEDOCS_VERSION=latest
14+
1015
# Put it first so that "make" without argument is like "make help".
1116
help:
1217
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -19,4 +24,4 @@ help:
1924
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2025

2126
livehtml:
22-
sphinx-autobuild -b html --ignore "autoapi/*" --ignore "*#*" --watch "../hoverxref" $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
27+
sphinx-autobuild -E -b html --ignore "autoapi/*" --ignore "*#*" --watch "../hoverxref" $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html

0 commit comments

Comments
 (0)