diff --git a/ChangeLog.rst b/docs/ChangeLog.rst similarity index 100% rename from ChangeLog.rst rename to docs/ChangeLog.rst diff --git a/INSTALL.rst b/docs/INSTALL.rst similarity index 100% rename from INSTALL.rst rename to docs/INSTALL.rst diff --git a/LAB_SETUP.rst b/docs/LAB_SETUP.rst similarity index 95% rename from LAB_SETUP.rst rename to docs/LAB_SETUP.rst index 564fab623c..7917d279a0 100644 --- a/LAB_SETUP.rst +++ b/docs/LAB_SETUP.rst @@ -12,7 +12,7 @@ We started by setting aside two of the test machines: one as the 'teuthology nod paddles/pulpito node ==================== -We're currently running both paddles and pulpito on the same node. We have a proxy server up front listening on port 80 that forwards to the proper service based on which hostname is used. Feel free to modify our `paddles `_ and `pulpito `_ configurations for your use. +We're currently running both paddles and pulpito on the same node. We have a proxy server up front listening on port 80 that forwards to the proper service based on which hostname is used. Feel free to modify our `paddles <_static/nginx_paddles>`_ and `pulpito <_static/nginx_pulpito>`_ configurations for your use. Do the following as root or as another user with sudo access:: @@ -135,6 +135,6 @@ Serving Test Logs pulpito tries to provide links to test logs. Out-of-the-box, those links will be broken, but are easy to fix. -First, install your favorite web server on the teuthology node. If you use nginx, you may use `our configuration `_ as a template. +First, install your favorite web server on the teuthology node. If you use nginx, you may use `our configuration <_static/nginx_test_logs>`_ as a template. Once you've got log files being served, edit paddles' ``config.py`` and update the ``job_log_href_templ`` value. Restart paddles when you're done. diff --git a/docs/Makefile b/docs/Makefile index 7899567f15..9e3a72f22e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -SOURCEDIR = source +SOURCEDIR = . BUILDDIR = build # User-friendly check for sphinx-build diff --git a/docs/reference/create_nodes.py b/docs/_static/create_nodes.py similarity index 100% rename from docs/reference/create_nodes.py rename to docs/_static/create_nodes.py diff --git a/docs/reference/nginx_paddles b/docs/_static/nginx_paddles similarity index 100% rename from docs/reference/nginx_paddles rename to docs/_static/nginx_paddles diff --git a/docs/reference/nginx_pulpito b/docs/_static/nginx_pulpito similarity index 100% rename from docs/reference/nginx_pulpito rename to docs/_static/nginx_pulpito diff --git a/docs/reference/nginx_test_logs b/docs/_static/nginx_test_logs similarity index 100% rename from docs/reference/nginx_test_logs rename to docs/_static/nginx_test_logs diff --git a/docs/reference/worker_start.sh b/docs/_static/worker_start.sh similarity index 100% rename from docs/reference/worker_start.sh rename to docs/_static/worker_start.sh diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Book.eot b/docs/_themes/ceph/static/font/ApexSans-Book.eot similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Book.eot rename to docs/_themes/ceph/static/font/ApexSans-Book.eot diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Book.svg b/docs/_themes/ceph/static/font/ApexSans-Book.svg similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Book.svg rename to docs/_themes/ceph/static/font/ApexSans-Book.svg diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Book.ttf b/docs/_themes/ceph/static/font/ApexSans-Book.ttf similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Book.ttf rename to docs/_themes/ceph/static/font/ApexSans-Book.ttf diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Book.woff b/docs/_themes/ceph/static/font/ApexSans-Book.woff similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Book.woff rename to docs/_themes/ceph/static/font/ApexSans-Book.woff diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Medium.eot b/docs/_themes/ceph/static/font/ApexSans-Medium.eot similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Medium.eot rename to docs/_themes/ceph/static/font/ApexSans-Medium.eot diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Medium.svg b/docs/_themes/ceph/static/font/ApexSans-Medium.svg similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Medium.svg rename to docs/_themes/ceph/static/font/ApexSans-Medium.svg diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Medium.ttf b/docs/_themes/ceph/static/font/ApexSans-Medium.ttf similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Medium.ttf rename to docs/_themes/ceph/static/font/ApexSans-Medium.ttf diff --git a/docs/source/_themes/ceph/static/font/ApexSans-Medium.woff b/docs/_themes/ceph/static/font/ApexSans-Medium.woff similarity index 100% rename from docs/source/_themes/ceph/static/font/ApexSans-Medium.woff rename to docs/_themes/ceph/static/font/ApexSans-Medium.woff diff --git a/docs/source/_themes/ceph/static/nature.css_t b/docs/_themes/ceph/static/nature.css_t similarity index 100% rename from docs/source/_themes/ceph/static/nature.css_t rename to docs/_themes/ceph/static/nature.css_t diff --git a/docs/source/_themes/ceph/theme.conf b/docs/_themes/ceph/theme.conf similarity index 100% rename from docs/source/_themes/ceph/theme.conf rename to docs/_themes/ceph/theme.conf diff --git a/docs/source/conf.py b/docs/conf.py similarity index 99% rename from docs/source/conf.py rename to docs/conf.py index 7a3200f795..1dc0675770 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -129,7 +129,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -#html_static_path = ['_static'] +html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/source/contents.rst b/docs/contents.rst similarity index 100% rename from docs/source/contents.rst rename to docs/contents.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..72a3355815 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/docs/source/ChangeLog.rst b/docs/source/ChangeLog.rst deleted file mode 100644 index 705b295913..0000000000 --- a/docs/source/ChangeLog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog.rst diff --git a/docs/source/INSTALL.rst b/docs/source/INSTALL.rst deleted file mode 100644 index 545ae4fa15..0000000000 --- a/docs/source/INSTALL.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../INSTALL.rst diff --git a/docs/source/LAB_SETUP.rst b/docs/source/LAB_SETUP.rst deleted file mode 100644 index d9a11f5fbd..0000000000 --- a/docs/source/LAB_SETUP.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../LAB_SETUP.rst diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index a6210d3d8a..0000000000 --- a/docs/source/index.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/tox.ini b/tox.ini index c03b22768c..8cfc64a379 100644 --- a/tox.ini +++ b/tox.ini @@ -35,7 +35,7 @@ commands=flake8 --select=F {posargs:teuthology scripts} [testenv:docs] basepython=python -changedir=docs/source +changedir=docs deps=sphinx commands= sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html