From b932046eb3b8562ae8d8afccca0517b3ec455919 Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Mon, 12 Mar 2018 22:03:44 +0900 Subject: [PATCH] Change ironic-specs webpage from oslosphinx to openstackdocstheme Change-Id: Ib9fdc57813d9812dd6ed69bf5a02076fa4e9db11 Closes-Bug: #1755165 --- doc/source/conf.py | 58 ++++++---------------------------------------- requirements.txt | 4 ++-- tox.ini | 3 +-- 3 files changed, 10 insertions(+), 55 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2e4719e8..4f6f47b3 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,14 +30,9 @@ import os extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'oslosphinx', - 'yasfb', + 'openstackdocstheme', ] -# Feed configuration for yasfb -feed_base_url = 'http://specs.openstack.org/openstack/ironic-specs' -feed_author = 'OpenStack Ironic Team' - todo_include_todos = True # Add any paths that contain templates here, relative to this directory. @@ -100,7 +95,7 @@ man_pages = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'nature' +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 @@ -128,8 +123,7 @@ html_theme = 'nature' # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" -html_last_updated_fmt = os.popen(git_cmd).read() +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. @@ -232,45 +226,7 @@ texinfo_documents = [ # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' - -# -- Options for Epub output --------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = u'Ironic Specs' -epub_author = u'OpenStack Ironic Team' -epub_publisher = u'OpenStack Ironic Team' -epub_copyright = u'2014, OpenStack Ironic Team' - -# The language of the text. It defaults to the language option -# or en if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files shat should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -#epub_exclude_files = [] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True +# openstackdocstheme options +repository_name = 'openstack/ironic-specs' +bug_project = 'ironic' +bug_tag = '' diff --git a/requirements.txt b/requirements.txt index 7d5e3155..047bfdfb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ -oslosphinx>=2.2.0.0a2 pbr>=0.6,!=0.7,<1.0 -sphinx>=1.1.2,<1.2 +sphinx!=1.6.6,<1.7.0,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 testrepository>=0.0.18 testtools>=0.9.34 yasfb>=0.5.1 diff --git a/tox.ini b/tox.ini index 769c45cc..ea6a93ea 100644 --- a/tox.ini +++ b/tox.ini @@ -19,5 +19,4 @@ commands = commands = {posargs} [testenv:docs] -basepython = python2 -commands = python setup.py build_sphinx +commands = sphinx-build -b html doc/source doc/build/html