add deprecation notice
authorPaul Angus <paul.angus@shapeblue.com>
Tue, 14 Aug 2018 13:58:26 +0000 (14:58 +0100)
committerPaul Angus <paul.angus@shapeblue.com>
Tue, 14 Aug 2018 13:58:26 +0000 (14:58 +0100)
rtd/make.bat [new file with mode: 0644]
rtd/source/archive_notice.rst [new file with mode: 0644]
rtd/source/conf.py

diff --git a/rtd/make.bat b/rtd/make.bat
new file mode 100644 (file)
index 0000000..d704d3c
--- /dev/null
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+       set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=ApacheCloudStack
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+       echo.
+       echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+       echo.installed, then set the SPHINXBUILD environment variable to point
+       echo.to the full path of the 'sphinx-build' executable. Alternatively you
+       echo.may add the Sphinx directory to PATH.
+       echo.
+       echo.If you don't have Sphinx installed, grab it from
+       echo.http://sphinx-doc.org/
+       exit /b 1
+)
+rd %BUILDDIR% /q /s
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/rtd/source/archive_notice.rst b/rtd/source/archive_notice.rst
new file mode 100644 (file)
index 0000000..b8a0301
--- /dev/null
@@ -0,0 +1,8 @@
+
+
+.. WARNING::
+
+   NOTICE: THIS DOCUMENTATION SITE HAS BEEN SUPERSEDED.
+
+
+   For the current documentation site goto: `http://docs.cloudstack.apache.org <http://docs.cloudstack.apache.org>`_
index 1fc6e29..ea75aad 100644 (file)
@@ -421,3 +421,7 @@ epub_copyright = u'2016, Apache CloudStack'
 
 # If false, no index is generated.
 #epub_use_index = True
+
+rst_prolog = """
+.. include:: /archive_notice.rst 
+"""