Commit 62eaf9d4 authored by Hanxi Liu's avatar Hanxi Liu

Docs: switch to openstackdocstheme

Project documents are being reprocessed due to document migration[1].
Update the docs theme to openstackdocstheme instead of oslosphinx.

[1] https://review.openstack.org/#/c/472275/

Change-Id: I505d837cc4e60356497cd37a8c9a12f846ffdf0d
parent 45b13c50
......@@ -39,13 +39,12 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
# They can be extensions coming with Sphinx (named 'sphinx.ext.*')
# or your custom ones.
extensions = [
'openstackdocstheme',
'sphinx.ext.autodoc',
'sphinxcontrib.autohttp.flask',
'wsmeext.sphinxext',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinxcontrib.pecanwsme.rest',
'oslosphinx',
]
wsme_protocols = ['restjson', 'restxml']
......@@ -116,13 +115,12 @@ nitpicky = False
# a list of builtin themes.
# html_theme_path = ['.']
# html_theme = '_theme'
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
# documentation.
html_theme_options = {
"nosidebar": "false"
}
# openstackdocstheme options
repository_name = 'openstack/ceilometer'
bug_project = 'ceilometer'
bug_tag = ''
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
......@@ -150,15 +148,8 @@ html_theme_options = {
# 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'
try:
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
except Exception:
warnings.warn('Cannot get last updated time from git repository. '
'Not setting "html_last_updated_fmt".')
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
......
......@@ -38,7 +38,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'oslosphinx',
'openstackdocstheme',
'reno.sphinxext',
]
......@@ -112,7 +112,12 @@ 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'
# openstackdocstheme options
repository_name = 'openstack/ceilometer'
bug_project = 'ceilometer'
bug_tag = ''
# 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
......@@ -150,7 +155,8 @@ 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'
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
......
......@@ -9,14 +9,13 @@ mock>=1.2 # BSD
os-win>=0.2.3 # Apache-2.0
oslo.cache>=1.5.0 # Apache-2.0
# Docs Requirements
openstackdocstheme>=1.0.3 # Apache-2.0
oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
openstackdocstheme>=1.11.0 # Apache-2.0
reno>=1.6.2 # Apache2
oslotest>=2.15.0 # Apache-2.0
oslo.vmware>=1.16.0 # Apache-2.0
python-subunit>=0.0.18 # Apache-2.0/BSD
pyOpenSSL>=0.14 # Apache-2.0
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
sphinx>=1.6.2 # BSD
sphinxcontrib-httpdomain # BSD
sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment