From b2cc3c99f77b96116aa9ba9ace4c7a9704cd5efc Mon Sep 17 00:00:00 2001 From: Van Hung Pham Date: Mon, 3 Jul 2017 10:35:24 +0700 Subject: [PATCH] doc: Switch from oslosphinx to openstackdocstheme Change-Id: Iedc8d2b1f75701b7fa92c53629b60701e2a2e659 --- doc/source/conf.py | 14 ++++++++++++-- releasenotes/source/conf.py | 12 +++++++++--- test-requirements.txt | 2 +- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index caea1e505..294c18ad8 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,8 +22,8 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -55,12 +55,16 @@ 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'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +# 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' + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). @@ -73,3 +77,9 @@ latex_documents = [ # Example configuration for intersphinx: refer to the Python standard library. #intersphinx_mapping = {'http://docs.python.org/': None} + +# -- Options for openstackdocstheme ------------------------------------------- + +repository_name = 'openstack/os-brick' +bug_project = 'os-brick' +bug_tag = '' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 1f84d73f2..14825e27a 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,8 +38,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', 'reno.sphinxext', + 'openstackdocstheme', ] # Add any paths that contain templates here, relative to this directory. @@ -112,7 +112,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 @@ -150,7 +150,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. @@ -277,3 +277,9 @@ texinfo_documents = [ # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] + +# -- Options for openstackdocstheme ------------------------------------------- + +repository_name = 'openstack/os-brick' +bug_project = 'os-brick' +bug_tag = '' diff --git a/test-requirements.txt b/test-requirements.txt index ce29c2ccd..09431802d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,7 +8,7 @@ ddt>=1.0.1 # MIT python-subunit>=0.0.18 # Apache-2.0/BSD reno!=2.3.1,>=1.8.0 # Apache-2.0 sphinx>=1.6.2 # BSD -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.16.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD