Reorganize documentation and Sphinx files

This should allow a more consistent experience between reading Sphinx-generated HTML docs and just using GitHub's renderer. Signed-off-by: Zack Cerza <[email protected]>
jdurgin · Dec 2, 2014 · e76a681 · e76a681
1 parent 933f7dc
commit e76a681
Show file tree

Hide file tree

Showing 27 changed files with 6 additions and 9 deletions.
diff --git a/ChangeLog.rst → docs/ChangeLog.rst b/ChangeLog.rst → docs/ChangeLog.rst
diff --git a/INSTALL.rst → docs/INSTALL.rst b/INSTALL.rst → docs/INSTALL.rst
diff --git a/LAB_SETUP.rst → docs/LAB_SETUP.rst b/LAB_SETUP.rst → 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 <docs/reference/nginx_paddles>`_ and `pulpito <docs/reference/nginx_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 <docs/reference/nginx_test_logs>`_ 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
@@ -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 → docs/_static/create_nodes.py b/docs/reference/create_nodes.py → docs/_static/create_nodes.py
diff --git a/docs/reference/nginx_paddles → docs/_static/nginx_paddles b/docs/reference/nginx_paddles → docs/_static/nginx_paddles
diff --git a/docs/reference/nginx_pulpito → docs/_static/nginx_pulpito b/docs/reference/nginx_pulpito → docs/_static/nginx_pulpito
diff --git a/docs/reference/nginx_test_logs → docs/_static/nginx_test_logs b/docs/reference/nginx_test_logs → docs/_static/nginx_test_logs
diff --git a/docs/reference/worker_start.sh → docs/_static/worker_start.sh b/docs/reference/worker_start.sh → docs/_static/worker_start.sh
diff --git a/...themes/ceph/static/font/ApexSans-Book.eot → ...themes/ceph/static/font/ApexSans-Book.eot b/...themes/ceph/static/font/ApexSans-Book.eot → ...themes/ceph/static/font/ApexSans-Book.eot
diff --git a/...themes/ceph/static/font/ApexSans-Book.svg → ...themes/ceph/static/font/ApexSans-Book.svg b/...themes/ceph/static/font/ApexSans-Book.svg → ...themes/ceph/static/font/ApexSans-Book.svg
diff --git a/...themes/ceph/static/font/ApexSans-Book.ttf → ...themes/ceph/static/font/ApexSans-Book.ttf b/...themes/ceph/static/font/ApexSans-Book.ttf → ...themes/ceph/static/font/ApexSans-Book.ttf
diff --git a/...hemes/ceph/static/font/ApexSans-Book.woff → ...hemes/ceph/static/font/ApexSans-Book.woff b/...hemes/ceph/static/font/ApexSans-Book.woff → ...hemes/ceph/static/font/ApexSans-Book.woff
diff --git a/...emes/ceph/static/font/ApexSans-Medium.eot → ...emes/ceph/static/font/ApexSans-Medium.eot b/...emes/ceph/static/font/ApexSans-Medium.eot → ...emes/ceph/static/font/ApexSans-Medium.eot
diff --git a/...emes/ceph/static/font/ApexSans-Medium.svg → ...emes/ceph/static/font/ApexSans-Medium.svg b/...emes/ceph/static/font/ApexSans-Medium.svg → ...emes/ceph/static/font/ApexSans-Medium.svg
diff --git a/...emes/ceph/static/font/ApexSans-Medium.ttf → ...emes/ceph/static/font/ApexSans-Medium.ttf b/...emes/ceph/static/font/ApexSans-Medium.ttf → ...emes/ceph/static/font/ApexSans-Medium.ttf
diff --git a/...mes/ceph/static/font/ApexSans-Medium.woff → ...mes/ceph/static/font/ApexSans-Medium.woff b/...mes/ceph/static/font/ApexSans-Medium.woff → ...mes/ceph/static/font/ApexSans-Medium.woff
diff --git a/docs/source/_themes/ceph/static/nature.css_t → docs/_themes/ceph/static/nature.css_t b/docs/source/_themes/ceph/static/nature.css_t → docs/_themes/ceph/static/nature.css_t
diff --git a/docs/source/_themes/ceph/theme.conf → docs/_themes/ceph/theme.conf b/docs/source/_themes/ceph/theme.conf → docs/_themes/ceph/theme.conf
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → 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 → docs/contents.rst b/docs/source/contents.rst → docs/contents.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1 @@
+.. include:: ../README.rst
diff --git a/docs/source/ChangeLog.rst b/docs/source/ChangeLog.rst
diff --git a/docs/source/INSTALL.rst b/docs/source/INSTALL.rst
diff --git a/docs/source/LAB_SETUP.rst b/docs/source/LAB_SETUP.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git 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