Skip to content
This repository has been archived by the owner on Sep 26, 2019. It is now read-only.

Commit

Permalink
Use openstackdocstheme for documentation
Browse files Browse the repository at this point in the history
Change-Id: I208cc61bd326a157527b09dbe828b16815a6c64f
Signed-off-by: Pengfei Ni <feiskyer@gmail.com>
  • Loading branch information
feiskyer committed Aug 4, 2017
1 parent 4dd67bf commit 4e4141a
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 6 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,7 @@
_output
deployment/kubestack/kubestack
deployment/stackube-controller/stackube-controller
deployment/stackube-proxy/stackube-proxy
deployment/stackube-proxy/stackube-proxy

# generated files
doc/build
17 changes: 13 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,17 @@
'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

Expand All @@ -71,7 +80,7 @@

# 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
Expand All @@ -80,6 +89,7 @@
# 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.
Expand Down Expand Up @@ -123,8 +133,7 @@
# 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
Expand Down
3 changes: 2 additions & 1 deletion test-requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 4e4141a

Please sign in to comment.