File 0001-Switch-from-oslosphinx-to-openstackdocsthe... of Package python-oneviewclient

Overview Repositories Revisions Requests Users Attributes Meta

File 0001-Switch-from-oslosphinx-to-openstackdocstheme.patch of Package python-oneviewclient

From c110bc50d1a5d1997124a70af1102cc1ca1718d1 Mon Sep 17 00:00:00 2001
From: Thomas Bechtold <tbechtold@suse.com>
Date: Mon, 7 Oct 2019 14:52:47 +0200
Subject: [PATCH] Switch from oslosphinx to openstackdocstheme

That's what the OpenStack community is using today. Also with newer
Sphinx versions, the current approach does no longer build.

Change-Id: Id2b82af22bd159be7f006ac0ffec870dfa30858e
---
 doc/source/conf.py    | 6 +++++-
 test-requirements.txt | 5 +++--
 tox.ini               | 3 ++-
 3 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index e46b33b..19b4dee 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -23,7 +23,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
@@ -57,6 +57,7 @@ pygments_style = 'sphinx'
 # html_theme_path = ["."]
 # html_theme = '_theme'
 # html_static_path = ['static']
+html_theme = 'openstackdocs'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
@@ -73,3 +74,6 @@ latex_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 #intersphinx_mapping = {'http://docs.python.org/': None}
+
+# openstackdocstheme options
+repository_name = 'openstack/python-oneviewclient'
diff --git a/test-requirements.txt b/test-requirements.txt
index cba4926..419849f 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,8 +6,9 @@ hacking<0.11,>=0.10.0
 
 coverage!=4.4,>=4.0 # Apache-2.0
 python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx!=1.6.1,>=1.5.1 # BSD
-oslosphinx>=4.7.0 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7'  # BSD
+sphinx!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4'  # BSD
+openstackdocstheme  # 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
diff --git a/tox.ini b/tox.ini
index 80f8efb..291bfed 100644
--- a/tox.ini
+++ b/tox.ini
@@ -21,7 +21,8 @@ commands = {posargs}
 commands = python setup.py test --coverage --testr-args='{posargs}'
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+commands =
+  sphinx-build -b html doc/source doc/build/html
 
 [testenv:debug]
 commands = oslo_debug_helper {posargs}
-- 
2.23.0

Places

File 0001-Switch-from-oslosphinx-to-openstackdocstheme.patch of Package python-oneviewclient

Places