RTD appears to have some issues with pathing and auto-detection of where
docs is located. Moving docs to a directory called docs/ seems to help
it find the docs and submodules correctly as this is one of the first
directories RTD searches.
Change-Id: I5aef11b7571fb29022076014b6323ce858219cfb
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
23 files changed:
[submodule "source/submodules/releng/builder"]
[submodule "source/submodules/releng/builder"]
- path = source/submodules/releng/builder
+ path = docs/submodules/releng/builder
url = ../releng/builder
branch = master
url = ../releng/builder
branch = master
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
rm -rf $(BUILDDIR)/*
.PHONY: html
rm -rf $(BUILDDIR)/*
.PHONY: html
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
-_submodules:
- git submodule update --init
if "%SPHINXBUILD%" == "" (\r
set SPHINXBUILD=sphinx-build\r
)\r
if "%SPHINXBUILD%" == "" (\r
set SPHINXBUILD=sphinx-build\r
)\r
-set BUILDDIR=build\r
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source\r
-set I18NSPHINXOPTS=%SPHINXOPTS% source\r
+set BUILDDIR=_build\r
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .\r
+set I18NSPHINXOPTS=%SPHINXOPTS% .\r
if NOT "%PAPER%" == "" (\r
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\r
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\r
if NOT "%PAPER%" == "" (\r
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\r
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\r