From 4e4141ac9d859447b20cdc939f2149f290d6bf80 Mon Sep 17 00:00:00 2001 From: Pengfei Ni Date: Fri, 4 Aug 2017 10:10:00 +0800 Subject: [PATCH] Use openstackdocstheme for documentation Change-Id: I208cc61bd326a157527b09dbe828b16815a6c64f Signed-off-by: Pengfei Ni --- .gitignore | 5 ++++- doc/source/conf.py | 17 +++++++++++++---- test-requirements.txt | 3 ++- 3 files changed, 19 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 1502faa..1cb1385 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,7 @@ _output deployment/kubestack/kubestack deployment/stackube-controller/stackube-controller -deployment/stackube-proxy/stackube-proxy \ No newline at end of file +deployment/stackube-proxy/stackube-proxy + +# generated files +doc/build diff --git a/doc/source/conf.py b/doc/source/conf.py index 3901e72..9b5f17b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,8 +48,17 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig', 'sphinx.ext.graphviz', 'sphinx.ext.todo', + 'openstackdocstheme', 'oslosphinx', - 'support_matrix'] + 'support_matrix', + 'oslo_config.sphinxext', + 'oslo_config.sphinxconfiggen', + ] + +# openstackdocstheme options +repository_name = 'openstack/stackube' +bug_project = 'stackube' +bug_tag = 'doc' todo_include_todos = True @@ -71,7 +80,7 @@ master_doc = 'index' # General information about the project. project = u'Stackube' -copyright = u'2011-present, OpenStack Foundation.' +copyright = u'2017-present, OpenStack Foundation.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -80,6 +89,7 @@ copyright = u'2011-present, OpenStack Foundation.' # Version info # The short X.Y version. # TODO(harry) No stackube version info yet +version = "0.1" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -123,8 +133,7 @@ modindex_common_prefix = ['stackube.'] # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. # html_theme_path = ["."] -html_theme_path = [os.path.join(os.path.dirname(oslosphinx.__file__), 'theme')] -html_theme = 'openstack' +html_theme = 'openstackdocs' # 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 aff56d6..8433594 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,2 +1,3 @@ -sphinx!=1.6.1,>=1.5.1 # BSD +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.16.0 # Apache-2.0 oslosphinx>=4.7.0 # Apache-2.0