x/monitorstack
Code Issues Proposed changes

Switch from oslosphinx to openstackdocstheme

Browse Source 
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

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

Change-Id: I7c001fa8f627dc991759e157a802588962af53d9
This commit is contained in:
Van Hung Pham
2017-06-29 14:01:36 +07:00
parent aab54fecfd
commit 66d45fc53d
3 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/conf.py
View File

@@ -23,8 +23,6 @@
"""Docs config for monitorstck.""" """Docs config for monitorstck."""
import os import os
import openstackdocstheme
import pbr.version import pbr.version
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
@@ -47,7 +45,7 @@ import pbr.version
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'oslosphinx', 'openstackdocstheme',
'sphinxmark' 'sphinxmark'
] ]
@@ -133,8 +131,12 @@ html_theme_options = {
} }
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()] # html_theme_path = ["."]
# 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'
# -- Options for HTMLHelp output ------------------------------------------ # -- Options for HTMLHelp output ------------------------------------------

9
releasenotes/source/conf.py
View File

@@ -23,8 +23,6 @@
"""Release notes for monitorstack.""" """Release notes for monitorstack."""
import os import os
import openstackdocstheme
import pbr.version import pbr.version
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
@@ -46,7 +44,7 @@ import pbr.version
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'oslosphinx', 'openstackdocstheme',
'reno.sphinxext', 'reno.sphinxext',
] ]
@@ -131,8 +129,11 @@ html_theme = 'openstackdocs'
# html_theme_options = {} # html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory. # Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()] # html_theme_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# -- Options for HTMLHelp output ------------------------------------------ # -- Options for HTMLHelp output ------------------------------------------

3
test-requirements.txt
View File

@@ -8,8 +8,7 @@ flake8-import-order==0.11 # LGPLv3
mock>=2.0 # BSD mock>=2.0 # BSD
# this is required for the docs build jobs # this is required for the docs build jobs
sphinx>=1.5.1 # BSD sphinx>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0
openstackdocstheme>=1.5.0 # Apache-2.0 openstackdocstheme>=1.5.0 # Apache-2.0
doc8 # Apache-2.0 doc8 # Apache-2.0
reno>=1.8.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0