Skip to content

Commit f9b78a9

Browse files
committed
Configure sphinx to require 1.5 for building htmlhelp
* This version contains the fix for sphinx-doc/sphinx#2550 so we want to assume it is present and tidy up all the external links. However if needed (and you don't care about the external links being broken) you can locally remove this version requirement.
1 parent 2cc8648 commit f9b78a9

File tree

4 files changed

+10
-3
lines changed

4 files changed

+10
-3
lines changed

docs/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ json:
9393

9494
.PHONY: htmlhelp
9595
htmlhelp:
96-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
96+
$(SPHINXBUILD) -b htmlhelp -t htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
9797
# Copy handwritten index file to output, overwriting auto-generated one
9898
@cp renderdoc.hhk $(BUILDDIR)/htmlhelp
9999
# Copy introduction page over index.html

docs/conf.py

+7
Original file line numberDiff line numberDiff line change
@@ -294,3 +294,10 @@
294294
'show_source': False,
295295
'html_show_sourcelink': False,
296296
}
297+
298+
# We need 1.5 and above for the htmlhelp links to be handled properly without
299+
# needing separate ugly _blank links. If you don't care about that, you can
300+
# disable this
301+
if(tags.has('htmlhelp')):
302+
print("**** We require sphinx 1.5 for htmlhelp build to have the fix for issue #2550 ****")
303+
needs_sphinx = '1.5'

docs/make.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ if "%1" == "json" (
120120
)
121121

122122
if "%1" == "htmlhelp" (
123-
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
123+
%SPHINXBUILD% -b htmlhelp -t htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
124124
if errorlevel 1 exit /b 1
125125
REM Copy handwritten index file to output, overwriting auto-generated one
126126
copy renderdoc.hhk %BUILDDIR%\htmlhelp\

docs/make.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ if [ $1 == "json" ]; then
102102
fi
103103

104104
if [ $1 == "htmlhelp" ]; then
105-
$SPHINXBUILD -b htmlhelp $ALLSPHINXOPTS $BUILDDIR/htmlhelp
105+
$SPHINXBUILD -b htmlhelp -t htmlhelp $ALLSPHINXOPTS $BUILDDIR/htmlhelp
106106
if [ $? != 0 ]; then exit 1; fi
107107
# Copy handwritten index file to output, overwriting auto-generated one
108108
cp renderdoc.hhk $BUILDDIR/htmlhelp

0 commit comments

Comments
 (0)