x/stackube
Code Issues Proposed changes

Use openstackdocstheme for documentation

Browse Source 
Change-Id: I208cc61bd326a157527b09dbe828b16815a6c64f
Signed-off-by: Pengfei Ni <feiskyer@gmail.com>
This commit is contained in:
Pengfei Ni 2017-08-04 10:10:00 +08:00
parent 4dd67bf6ab
commit 4e4141ac9d
3 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -3,3 +3,6 @@ _output
deployment/kubestack/kubestack deployment/kubestack/kubestack
deployment/stackube-controller/stackube-controller deployment/stackube-controller/stackube-controller
deployment/stackube-proxy/stackube-proxy deployment/stackube-proxy/stackube-proxy
# generated files
doc/build

17
doc/source/conf.py
View File

@ -48,8 +48,17 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.ifconfig', 'sphinx.ext.ifconfig',
'sphinx.ext.graphviz', 'sphinx.ext.graphviz',
'sphinx.ext.todo', 'sphinx.ext.todo',
'openstackdocstheme',
'oslosphinx', '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 todo_include_todos = True
@ -71,7 +80,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Stackube' 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 # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
@ -80,6 +89,7 @@ copyright = u'2011-present, OpenStack Foundation.'
# Version info # Version info
# The short X.Y version. # The short X.Y version.
# TODO(harry) No stackube version info yet # TODO(harry) No stackube version info yet
version = "0.1"
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # 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 # The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'. # Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."] # html_theme_path = ["."]
html_theme_path = [os.path.join(os.path.dirname(oslosphinx.__file__), 'theme')] html_theme = 'openstackdocs'
html_theme = 'openstack'
# Theme options are theme-specific and customize the look and feel of a 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 # further. For a list of options available for each theme, see the

3
test-requirements.txt
View File

@ -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 oslosphinx>=4.7.0 # Apache-2.0