From ad58c0f899751ca08174965ab007c5fc6b2e1e5c Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 28 Jun 2013 20:01:42 -0400 Subject: Use oslo.sphinx and remove local copy of doc theme Use the new oslo.sphinx version of the OpenStack doc theme instead of copying it into this repo. blueprint oslo.sphinx Signed-off-by: Doug Hellmann Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8 --- doc/source/_templates/.placeholder | 0 doc/source/_theme/layout.html | 83 -------------------------------------- doc/source/_theme/theme.conf | 4 -- doc/source/conf.py | 20 +++++---- test-requirements.txt | 3 ++ 5 files changed, 12 insertions(+), 98 deletions(-) delete mode 100644 doc/source/_templates/.placeholder delete mode 100644 doc/source/_theme/layout.html delete mode 100644 doc/source/_theme/theme.conf diff --git a/doc/source/_templates/.placeholder b/doc/source/_templates/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/doc/source/_theme/layout.html b/doc/source/_theme/layout.html deleted file mode 100644 index 750b7822..00000000 --- a/doc/source/_theme/layout.html +++ /dev/null @@ -1,83 +0,0 @@ -{% extends "basic/layout.html" %} -{% set css_files = css_files + ['_static/tweaks.css'] %} -{% set script_files = script_files + ['_static/jquery.tweet.js'] %} - -{%- macro sidebar() %} - {%- if not embedded %}{% if not theme_nosidebar|tobool %} -
-
- {%- block sidebarlogo %} - {%- if logo %} - - {%- endif %} - {%- endblock %} - {%- block sidebartoc %} - {%- if display_toc %} -

{{ _('Table Of Contents') }}

- {{ toc }} - {%- endif %} - {%- endblock %} - {%- block sidebarrel %} - {%- if prev %} -

{{ _('Previous topic') }}

-

{{ prev.title }}

- {%- endif %} - {%- if next %} -

{{ _('Next topic') }}

-

{{ next.title }}

- {%- endif %} - {%- endblock %} - {%- block sidebarsourcelink %} - {%- if show_source and has_source and sourcename %} -

{{ _('This Page') }}

- - {%- endif %} - {%- endblock %} - {%- if customsidebar %} - {% include customsidebar %} - {%- endif %} - {%- block sidebarsearch %} - {%- if pagename != "search" %} - - - {%- endif %} - {%- endblock %} -
-
- {%- endif %}{% endif %} -{%- endmacro %} - -{% block relbar1 %}{% endblock relbar1 %} - -{% block header %} - -{% endblock %} \ No newline at end of file diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf deleted file mode 100644 index 1cc40044..00000000 --- a/doc/source/_theme/theme.conf +++ /dev/null @@ -1,4 +0,0 @@ -[theme] -inherit = basic -stylesheet = nature.css -pygments_style = tango diff --git a/doc/source/conf.py b/doc/source/conf.py index 293edf44..cd585d68 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -28,21 +28,19 @@ sys.path.insert(0, os.path.abspath('../..')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', -# 'sphinx.ext.todo', 'sphinx.ext.coverage'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', - # 'sphinx.ect.intersphinx', - 'sphinx.ext.coverage'] + 'sphinx.ext.coverage', + 'oslo.sphinx', + ] todo_include_todos = True # Add any paths that contain templates here, relative to this directory. -templates_path = [] -if os.getenv('HUDSON_PUBLISH_DOCS'): - templates_path = ['_ga', '_templates'] -else: - templates_path = ['_templates'] +# if os.getenv('HUDSON_PUBLISH_DOCS'): +# templates_path = ['_ga', '_templates'] +# else: +# templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -109,8 +107,8 @@ man_pages = [ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme_path = ["."] -html_theme = '_theme' +# html_theme_path = ["."] +# html_theme = '_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/test-requirements.txt b/test-requirements.txt index 0f772cb0..64a82abe 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -35,3 +35,6 @@ netifaces # For translations processing Babel + +# For documentation +oslo.sphinx -- cgit