From adf26e3fc54e6316b6485828ae022e256a40308e Mon Sep 17 00:00:00 2001 From: Thanh Ha Date: Sat, 14 May 2016 17:04:31 -0400 Subject: [PATCH] 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 --- docs/.gitignore | 1 + Makefile => docs/Makefile | 6 +++--- {source => docs}/conf.py | 0 {source => docs}/getting-started-guide/api.rst | 0 .../getting-started-guide/concepts_and_tools.rst | 0 .../getting-started-guide/experimental_features.rst | 0 .../images/be-exp-features-1.png | Bin .../images/be-exp-features-2.png | Bin .../getting-started-guide/images/be-features-1.png | Bin .../getting-started-guide/images/be-features-2.png | Bin .../getting-started-guide/images/be-features-3.png | Bin .../getting-started-guide/images/be-nonfeatures.png | Bin {source => docs}/getting-started-guide/index.rst | 0 .../installing_opendaylight.rst | 0 .../getting-started-guide/introduction.rst | 0 .../getting-started-guide/karaf_features.rst | 0 .../getting-started-guide/other_features.rst | 0 {source => docs}/getting-started-guide/overview.rst | 0 .../getting-started-guide/who_should_use.rst | 0 {source => docs}/index.rst | 0 make.bat => docs/make.bat | 6 +++--- 21 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 docs/.gitignore rename Makefile => docs/Makefile (98%) rename {source => docs}/conf.py (100%) rename {source => docs}/getting-started-guide/api.rst (100%) rename {source => docs}/getting-started-guide/concepts_and_tools.rst (100%) rename {source => docs}/getting-started-guide/experimental_features.rst (100%) rename {source => docs}/getting-started-guide/images/be-exp-features-1.png (100%) rename {source => docs}/getting-started-guide/images/be-exp-features-2.png (100%) rename {source => docs}/getting-started-guide/images/be-features-1.png (100%) rename {source => docs}/getting-started-guide/images/be-features-2.png (100%) rename {source => docs}/getting-started-guide/images/be-features-3.png (100%) rename {source => docs}/getting-started-guide/images/be-nonfeatures.png (100%) rename {source => docs}/getting-started-guide/index.rst (100%) rename {source => docs}/getting-started-guide/installing_opendaylight.rst (100%) rename {source => docs}/getting-started-guide/introduction.rst (100%) rename {source => docs}/getting-started-guide/karaf_features.rst (100%) rename {source => docs}/getting-started-guide/other_features.rst (100%) rename {source => docs}/getting-started-guide/overview.rst (100%) rename {source => docs}/getting-started-guide/who_should_use.rst (100%) rename {source => docs}/index.rst (100%) rename make.bat => docs/make.bat (94%) diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..69fa449dd --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build/ diff --git a/Makefile b/docs/Makefile similarity index 98% rename from Makefile rename to docs/Makefile index 8fbbce784..04c2ae35c 100644 --- 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: 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 9e1338113..380a8848d 100644 --- a/make.bat +++ b/docs/make.bat @@ -5,9 +5,9 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set BUILDDIR=build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source -set I18NSPHINXOPTS=%SPHINXOPTS% source +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -- 2.36.6