Restructure to docs folder for RTD

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>

diff --git a/.gitmodules b/.gitmodules
index 7b771f7938c5d1e6f9f6c8cb6a9941b4454cd8a3..393fc89edebbfc14c3ced9d2d382a5ec55cf938a 100644 (file)
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,4 +1,4 @@
 [submodule "source/submodules/releng/builder"]
-       path = source/submodules/releng/builder
+       path = docs/submodules/releng/builder
        url = ../releng/builder
        branch = master

diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644 (file)
index 0000000..69fa449
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1 @@
+_build/

diff --git a/Makefile b/docs/Makefile
similarity index 97%
rename from Makefile
rename to docs/Makefile
index b74499bfaa6975755a6ddd70c73873bc2bd3c057..30feeced9e8f81f42876e9a2760592b2cb8a2510 100644 (file)
--- a/Makefile
+++ b/docs/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = build
+BUILDDIR      = _build
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -15,9 +15,9 @@ endif
 # 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
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
 .PHONY: help
 help:
@@ -53,7 +53,7 @@ clean:
        rm -rf $(BUILDDIR)/*
 
 .PHONY: html
-html: _submodules
+html:
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
        @echo
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@@ -222,5 +222,3 @@ pseudoxml:
        @echo
        @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 
-_submodules:
-       git submodule update --init

diff --git a/source/conf.py b/docs/conf.py
similarity index 100%
rename from source/conf.py
rename to docs/conf.py

diff --git a/source/getting-started-guide/api.rst b/docs/getting-started-guide/api.rst
similarity index 100%
rename from source/getting-started-guide/api.rst
rename to docs/getting-started-guide/api.rst

diff --git a/source/getting-started-guide/concepts_and_tools.rst b/docs/getting-started-guide/concepts_and_tools.rst
similarity index 100%
rename from source/getting-started-guide/concepts_and_tools.rst
rename to docs/getting-started-guide/concepts_and_tools.rst

diff --git a/source/getting-started-guide/experimental_features.rst b/docs/getting-started-guide/experimental_features.rst
similarity index 100%
rename from source/getting-started-guide/experimental_features.rst
rename to docs/getting-started-guide/experimental_features.rst

diff --git a/source/getting-started-guide/images/be-exp-features-1.png b/docs/getting-started-guide/images/be-exp-features-1.png
similarity index 100%
rename from source/getting-started-guide/images/be-exp-features-1.png
rename to docs/getting-started-guide/images/be-exp-features-1.png

diff --git a/source/getting-started-guide/images/be-exp-features-2.png b/docs/getting-started-guide/images/be-exp-features-2.png
similarity index 100%
rename from source/getting-started-guide/images/be-exp-features-2.png
rename to docs/getting-started-guide/images/be-exp-features-2.png

diff --git a/source/getting-started-guide/images/be-features-1.png b/docs/getting-started-guide/images/be-features-1.png
similarity index 100%
rename from source/getting-started-guide/images/be-features-1.png
rename to docs/getting-started-guide/images/be-features-1.png

diff --git a/source/getting-started-guide/images/be-features-2.png b/docs/getting-started-guide/images/be-features-2.png
similarity index 100%
rename from source/getting-started-guide/images/be-features-2.png
rename to docs/getting-started-guide/images/be-features-2.png

diff --git a/source/getting-started-guide/images/be-features-3.png b/docs/getting-started-guide/images/be-features-3.png
similarity index 100%
rename from source/getting-started-guide/images/be-features-3.png
rename to docs/getting-started-guide/images/be-features-3.png

diff --git a/source/getting-started-guide/images/be-nonfeatures.png b/docs/getting-started-guide/images/be-nonfeatures.png
similarity index 100%
rename from source/getting-started-guide/images/be-nonfeatures.png
rename to docs/getting-started-guide/images/be-nonfeatures.png

diff --git a/source/getting-started-guide/index.rst b/docs/getting-started-guide/index.rst
similarity index 100%
rename from source/getting-started-guide/index.rst
rename to docs/getting-started-guide/index.rst

diff --git a/source/getting-started-guide/installing_opendaylight.rst b/docs/getting-started-guide/installing_opendaylight.rst
similarity index 100%
rename from source/getting-started-guide/installing_opendaylight.rst
rename to docs/getting-started-guide/installing_opendaylight.rst

diff --git a/source/getting-started-guide/introduction.rst b/docs/getting-started-guide/introduction.rst
similarity index 100%
rename from source/getting-started-guide/introduction.rst
rename to docs/getting-started-guide/introduction.rst

diff --git a/source/getting-started-guide/karaf_features.rst b/docs/getting-started-guide/karaf_features.rst
similarity index 100%
rename from source/getting-started-guide/karaf_features.rst
rename to docs/getting-started-guide/karaf_features.rst

diff --git a/source/getting-started-guide/other_features.rst b/docs/getting-started-guide/other_features.rst
similarity index 100%
rename from source/getting-started-guide/other_features.rst
rename to docs/getting-started-guide/other_features.rst

diff --git a/source/getting-started-guide/overview.rst b/docs/getting-started-guide/overview.rst
similarity index 100%
rename from source/getting-started-guide/overview.rst
rename to docs/getting-started-guide/overview.rst

diff --git a/source/getting-started-guide/who_should_use.rst b/docs/getting-started-guide/who_should_use.rst
similarity index 100%
rename from source/getting-started-guide/who_should_use.rst
rename to docs/getting-started-guide/who_should_use.rst

diff --git a/source/index.rst b/docs/index.rst
similarity index 100%
rename from source/index.rst
rename to docs/index.rst

diff --git a/make.bat b/docs/make.bat
similarity index 94%
rename from make.bat
rename to docs/make.bat
index 9e13381137cf47db62277741f1ee9868c62f91b1..380a8848d914b7a9f573a635e4d8da1a35fc5da1 100644 (file)
--- a/make.bat
+++ b/docs/make.bat
@@ -5,9 +5,9 @@ REM Command file for Sphinx documentation
 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

diff --git a/source/submodules/releng/builder b/docs/submodules/releng/builder
similarity index 100%
rename from source/submodules/releng/builder
rename to docs/submodules/releng/builder