Migration from oslo_sphinx to openstackdocstheme
As a part of docs migration work[0] for pike we need to switch to openstackdocstheme Change-Id: I5e8f22efc1c0529b98f9baa60b369f4e692848f4
This commit is contained in:
parent
d16d932b77
commit
44e2303694
|
@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
# 'sphinx.ext.intersphinx',
|
||||
'oslosphinx'
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||
|
@ -54,7 +54,7 @@ pygments_style = 'sphinx'
|
|||
# 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 = '_theme'
|
||||
# html_theme = 'openstackdocs'
|
||||
# html_static_path = ['static']
|
||||
html_theme_options = {}
|
||||
|
||||
|
@ -73,3 +73,9 @@ latex_documents = [
|
|||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
# intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# -- Options for openstackdocstheme -------------------------------------------
|
||||
repository_name = 'openstack/barbican'
|
||||
ug_project = project.lower()
|
||||
bug_tag = ''
|
||||
|
|
|
@ -37,7 +37,7 @@
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'oslosphinx',
|
||||
'openstackdocstheme',
|
||||
'reno.sphinxext',
|
||||
]
|
||||
|
||||
|
@ -64,6 +64,12 @@ copyright = u'2015, Barbican Developers'
|
|||
from barbican.version import version_info as barbican_version
|
||||
# The short X.Y version.
|
||||
version = barbican_version.canonical_version_string()
|
||||
|
||||
# openstackdocstheme options
|
||||
epository_name = 'openstack/barbican'
|
||||
bug_project = project.lower()
|
||||
bug_tag = ''
|
||||
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = barbican_version.version_string_with_vcs()
|
||||
|
||||
|
@ -110,7 +116,7 @@ pygments_style = 'sphinx'
|
|||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'default'
|
||||
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
|
||||
|
@ -148,7 +154,7 @@ html_static_path = ['_static']
|
|||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
# html_last_updated_fmt = '%b %d, %Y'
|
||||
# html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
|
|
|
@ -24,7 +24,6 @@ bandit>=1.1.0 # Apache-2.0
|
|||
|
||||
# Documentation build requirements
|
||||
sphinx!=1.6.1,>=1.5.1 # BSD
|
||||
oslosphinx>=4.7.0 # Apache-2.0
|
||||
os-api-ref>=1.0.0 # Apache-2.0
|
||||
reno!=2.3.1,>=1.8.0 # Apache-2.0
|
||||
openstackdocstheme>=1.5.0 # Apache-2.0
|
||||
|
|
Loading…
Reference in New Issue